OptiRoutes Files API

Hva det er

Hvert firma i OptiRoutes har sin egen private filmappe: leveringene det laster inn, de signerte følgesedlene (POD) med bilder og signaturer, ruteeksportene og rapportene ved dagens slutt. Files API lar systemene deres lese og skrive i den mappen direkte, uten noen FTP-server imellom.

• Adresse: https://srv2.optiroutes.com/api/v1 – bare HTTPS.
• Tilgang: en API-nøkkel som lederen i firmaet oppretter i OptiRoutes, under Innstillinger → API og filer. Det trengs ingen henvendelse til kundestøtte hos OptiRoutes.
• Alle filtyper systemet jobber med i dag: CSV, JSON, TXT, XLSX/XLS, PDF og bilder.
• Svarene er JSON, unntatt nedlasting av filer, som returnerer selve filen.

Kom i gang i 3 trinn

1. Opprett en nøkkel. I OptiRoutes åpner lederen Innstillinger → API og filer, klikker på Ny nøkkel, gir den et navn (for eksempel «ERP-server»), velger tillatelsene og kopierer nøkkelen. Nøkkelen vises én gang.
2. Kontroller tilkoblingen.

   curl -H "Authorization: Bearer $OPTIROUTES_KEY" https://srv2.optiroutes.com/api/v1/me

3. Last ned dagens signerte POD-er som én ZIP:

   curl -H "Authorization: Bearer $OPTIROUTES_KEY" -o pod.zip "https://srv2.optiroutes.com/api/v1/pod/archive?date=$(date +%F)"

Sikkerhet – les dette

• Behandle nøkkelen som et passord. Oppbevar den i et hemmelighetslager eller en miljøvariabel på serveren. Legg den aldri i en nettside, en mobilapp, en e-post, en sak eller i kildekodekontroll.
• Minste tilgang. Gi hvert system sin egen nøkkel med bare tillatelsene det trenger: pod:read (bare signerte POD-er), files:read (les alle firmaets filer), files:write (last opp leveringer og innboksfiler).
• Begrens adressene. Når serveren har en fast IP-adresse, legger du den til på nøkkelen («Tillatte adresser»). Et kall fra en annen adresse avvises.
• Utløp og rotasjon. En nøkkel kan utløpe etter et antall dager. Slik roterer du: opprett en ny nøkkel, bytt systemet over til den, og tilbakekall deretter den gamle – uten nedetid.
• Tilbakekall med en gang en nøkkel som kan være lekket: Innstillinger → API og filer → Tilbakekall. Den slutter å virke innen 30 sekunder.
• Revisjon. Hvert kall logges (tid, adresse, fil, svar) og vises for lederen på samme skjerm.
• OptiRoutes lagrer bare et fingeravtrykk (SHA-256) av hver nøkkel, aldri selve nøkkelen. Tilkoblinger går bare over HTTPS (TLS 1.2+).
• En nøkkel når bare mappen til sitt eget firma. Andre firmaers filer og systemets interne mapper kan aldri nås.

Autentisering

Send nøkkelen i hver forespørsel, i en av disse hodene:

Authorization: Bearer opr_2813_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# or
X-API-Key: opr_2813_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

En nøkkel ser slik ut: opr_2813_… (firmanummeret, deretter 32 tilfeldige tegn).

Firmaets mappe

Referanse

Eksempel på svar fra en oppføring:

{
  "ok": true,
  "folder": "pod/2026/10/11/",
  "items": [
    { "name": "12345_sign_2026_10_11.pdf", "path": "pod/2026/10/11/12345_sign_2026_10_11.pdf",
      "type": "file", "size": 84213, "modified": "2026-10-11T09:14:02.000Z" }
  ]
}

Vanlige oppgaver

Last opp dagens leveringsfil

# curl (Linux / macOS / Windows 10+)
curl -X PUT -H "Authorization: Bearer $OPTIROUTES_KEY" \
     --data-binary @orders.csv -H "Content-Type: text/csv" \
     "https://srv2.optiroutes.com/api/v1/files?path=orders_files/$(date +%F).csv"

# PowerShell
Invoke-RestMethod -Method Put -InFile .\orders.csv -ContentType 'text/csv' `
  -Headers @{ Authorization = "Bearer $env:OPTIROUTES_KEY" } `
  -Uri "https://srv2.optiroutes.com/api/v1/files?path=orders_files/$(Get-Date -f yyyy-MM-dd).csv"

OptiRoutes laster inn filen slik den gjør i dag (den automatiske innlastingen under Innstillinger → Innlasting, eller brukerens «Last inn fil»).

Last ned de signerte POD-ene for én levering

curl -H "Authorization: Bearer $OPTIROUTES_KEY" "https://srv2.optiroutes.com/api/v1/pod?date=2026-10-11&order=12345"
# then, for each item:
curl -H "Authorization: Bearer $OPTIROUTES_KEY" -OJ "https://srv2.optiroutes.com/api/v1/files/download?path=pod/2026/10/11/12345_sign_2026_10_11.pdf"

Last ned rapporten ved dagens slutt

curl -H "Authorization: Bearer $OPTIROUTES_KEY" "https://srv2.optiroutes.com/api/v1/files?folder=reports/2026/10/"
curl -H "Authorization: Bearer $OPTIROUTES_KEY" -OJ "https://srv2.optiroutes.com/api/v1/files/download?path=reports/2026/10/report_2026_10_11.csv"

Python

import os, datetime, requests

BASE = "https://srv2.optiroutes.com/api/v1"
H = {"Authorization": f"Bearer {os.environ['OPTIROUTES_KEY']}"}

# upload today's orders
day = datetime.date.today().isoformat()
with open("orders.csv", "rb") as f:
    r = requests.put(f"{BASE}/files", params={"path": f"orders_files/{day}.csv"},
                     data=f, headers={**H, "Content-Type": "text/csv"}, timeout=60)
r.raise_for_status()

# download every signed POD of the day
pods = requests.get(f"{BASE}/pod", params={"date": day}, headers=H, timeout=60).json()["items"]
for p in pods:
    if p["kind"] == "signed_pdf":
        data = requests.get(f"{BASE}/files/download", params={"path": p["path"]}, headers=H, timeout=60)
        open(p["name"], "wb").write(data.content)

C# (.NET)

using var http = new HttpClient { BaseAddress = new Uri("https://srv2.optiroutes.com/api/v1/") };
http.DefaultRequestHeaders.Authorization =
    new("Bearer", Environment.GetEnvironmentVariable("OPTIROUTES_KEY"));

// upload today's orders
var day = DateTime.Today.ToString("yyyy-MM-dd");
using var content = new ByteArrayContent(File.ReadAllBytes("orders.csv"));
content.Headers.ContentType = new("text/csv");
(await http.PutAsync($"files?path=orders_files/{day}.csv", content)).EnsureSuccessStatusCode();

// the day's PODs as one ZIP
var zip = await http.GetByteArrayAsync($"pod/archive?date={day}");
File.WriteAllBytes($"pod-{day}.zip", zip);

Node.js

const BASE = 'https://srv2.optiroutes.com/api/v1';
const H = { Authorization: `Bearer ${process.env.OPTIROUTES_KEY}` };
const day = new Date().toISOString().slice(0, 10);

// list and download the day's signed PODs (Node 18+)
const { items } = await (await fetch(`${BASE}/pod?date=${day}`, { headers: H })).json();
for (const p of items.filter((i) => i.kind === 'signed_pdf')) {
  const res = await fetch(`${BASE}/files/download?path=${encodeURIComponent(p.path)}`, { headers: H });
  await require('fs/promises').writeFile(p.name, Buffer.from(await res.arrayBuffer()));
}

Jobb som med FTP – et skript for mappesynkronisering

Team som har jobbet med FTP, kan holde en mappe på sin egen server synkronisert med firmaets mappe: en planlagt oppgave laster ned nye filer (for eksempel POD-ene) og laster opp filene dere legger i en lokal mappe. PowerShell-skriptet nedenfor gjør begge deler; kjør det med noen minutters mellomrom fra Oppgaveplanlegging i Windows (på Linux bruker du curl-linjene med cron).

# optiroutes-sync.ps1 — download new PODs, upload what is in .\outbox (run every 5 minutes)
$Base  = 'https://srv2.optiroutes.com/api/v1'
$H     = @{ Authorization = "Bearer $env:OPTIROUTES_KEY" }
$Local = 'C:\OptiRoutes'
New-Item -ItemType Directory -Force "$Local\pod", "$Local\outbox", "$Local\sent" | Out-Null

# 1. today's and yesterday's PODs -> C:\OptiRoutes\pod\YYYY-MM-DD\
foreach ($d in (Get-Date), (Get-Date).AddDays(-1)) {
  $day = $d.ToString('yyyy-MM-dd'); $dir = "$Local\pod\$day"
  New-Item -ItemType Directory -Force $dir | Out-Null
  $list = Invoke-RestMethod -Headers $H -Uri "$Base/pod?date=$day"
  foreach ($f in $list.items) {
    $dest = Join-Path $dir $f.name
    if (-not (Test-Path $dest)) {
      Invoke-WebRequest -Headers $H -OutFile $dest -Uri ("$Base/files/download?path=" + [uri]::EscapeDataString($f.path))
    }
  }
}

# 2. every file in C:\OptiRoutes\outbox -> orders_files/, then moved to C:\OptiRoutes\sent
Get-ChildItem "$Local\outbox" -File | ForEach-Object {
  Invoke-RestMethod -Method Put -Headers $H -InFile $_.FullName -ContentType 'application/octet-stream' `
    -Uri ("$Base/files?path=" + [uri]::EscapeDataString("orders_files/" + $_.Name)) | Out-Null
  Move-Item $_.FullName "$Local\sent\" -Force
}

Flytte et firma fra FTP til API

Lederen bytter under Innstillinger → API og filer → Filene flyttes via: API. Fra det øyeblikket sendes ingenting til firmaets FTP, og alle filer ligger i stedet i firmaets mappe:

Nye firmaer jobber med API fra starten. Tilbake til FTP bytter du med den samme bryteren.

Firmaer på den gamle OptiRoutes-serveren

Et firma som fortsatt jobber med den gamle OptiRoutes-serveren (WEB), kan bruke API for de signerte POD-ene sine: opprett en nøkkel med tillatelsen pod:read og bruk /api/v1/pod, /api/v1/pod/archive og /api/v1/files/download?path=pod/…. De andre filene flyttes fortsatt som i dag, til firmaet flytter til den nye serveren.

Feil

En feil svarer med {"ok": false, "error": "<code>", "message": "<explanation>"}.

Grenser

• 300 forespørsler per minutt per nøkkel.
• 50 MB per fil.
• 20 aktive nøkler per firma.
• En mappeoppføring returnerer opptil 5 000 elementer; vis undermapper (for eksempel én dag med POD-er) for å få flere.

Hjelp

Lederen i firmaet ser hver nøkkel, når den sist ble brukt, og de siste kallene under Innstillinger → API og filer. For alt annet kontakter du kundestøtte hos OptiRoutes med firmanummeret og tidspunktet for kallet – send aldri selve nøkkelen.