OptiRoutes Files API

Kaj je to

Vsako podjetje v OptiRoutes ima svojo zasebno mapo datotek: naročila, ki jih naloži, podpisane dobavnice (POD) z njihovimi fotografijami in podpisi, izvoze poti in poročila ob koncu dneva. Files API vašim sistemom omogoča neposredno branje in pisanje v to mapo, brez vmesnega strežnika FTP.

• Naslov: https://srv2.optiroutes.com/api/v1 — samo HTTPS.
• Dostop: ključ API, ki ga vodja podjetja ustvari v OptiRoutes, v Nastavitve → API in datoteke. Zahteva podpori OptiRoutes ni potrebna.
• Vse vrste datotek, s katerimi sistem dela danes: CSV, JSON, TXT, XLSX/XLS, PDF in slike.
• Odgovori so v obliki JSON, razen pri prenosu datotek, ki vrne samo datoteko.

Začetek v 3 korakih

1. Ustvarite ključ. Vodja v OptiRoutes odpre Nastavitve → API in datoteke, klikne Nov ključ, mu da ime (na primer „strežnik ERP“), izbere dovoljenja in kopira ključ. Ključ je prikazan samo enkrat.
2. Preverite povezavo.

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

3. Prenesite današnje podpisane POD kot en ZIP:

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

Varnost — preberite

• S ključem ravnajte kot z geslom. Hranite ga v shrambi skrivnosti ali v spremenljivki okolja na svojem strežniku. Nikoli ga ne vstavljajte v spletno stran, mobilno aplikacijo, e-poštno sporočilo, zahtevek ali sistem za upravljanje izvorne kode.
• Najmanjša potrebna dovoljenja. Vsakemu sistemu dajte svoj ključ samo z dovoljenji, ki jih potrebuje: pod:read (samo podpisani POD), files:read (branje vseh datotek podjetja), files:write (nalaganje naročil in datotek v inbox).
• Omejite naslove. Če ima vaš strežnik fiksen naslov IP, ga dodajte ključu („Dovoljeni naslovi“). Klic s katerega koli drugega naslova je zavrnjen.
• Potek in menjava. Ključ lahko poteče po določenem številu dni. Za menjavo: ustvarite nov ključ, preklopite svoj sistem nanj, nato prekličite starega — brez prekinitve delovanja.
• Takoj prekličite ključ, ki je morda ušel: Nastavitve → API in datoteke → Prekliči. Nehal bo delovati v 30 sekundah.
• Revizija. Vsak klic se zabeleži (čas, naslov, datoteka, odgovor) in je prikazan vodji na istem zaslonu.
• OptiRoutes hrani samo prstni odtis (SHA-256) vsakega ključa, nikoli samega ključa. Povezave so samo prek HTTPS (TLS 1.2+).
• Ključ ima dostop samo do mape svojega podjetja. Do datotek drugih podjetij in notranjih map sistema ni mogoče priti nikoli.

Preverjanje pristnosti

Ključ pošljite v vsaki zahtevi, v eni od teh glav:

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

Ključ je videti kot opr_2813_… (številka podjetja, nato 32 naključnih znakov).

Mapa podjetja

Referenca

Primer odgovora seznama:

{
  "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" }
  ]
}

Pogosta opravila

Naložite današnjo datoteko naročil

# 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 naloži datoteko tako, kot jo nalaga danes (samodejno nalaganje v Nastavitve → Nalaganje ali uporabnikovo „Naloži datoteko“).

Prenesite podpisane POD enega naročila

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"

Prenesite poročilo ob koncu dneva

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()));
}

Delo kot s FTP — skript za sinhronizacijo mape

Ekipe, ki so delale s FTP, lahko mapo na lastnem strežniku sinhronizirajo z mapo podjetja: načrtovano opravilo prenese nove datoteke (na primer POD) in naloži datoteke, ki jih odložite v lokalno mapo. Spodnji skript PowerShell naredi oboje; zaženite ga vsakih nekaj minut iz Windows Task Scheduler (v Linuxu uporabite vrstice curl s 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
}

Prehod podjetja s FTP na API

Vodja preklopi v Nastavitve → API in datoteke → Datoteke se premikajo prek: API. Od tega trenutka se na FTP podjetja ne pošilja nič več, vsaka datoteka pa je namesto tega v mapi podjetja:

Nova podjetja delajo z API od začetka. Vrnitev na FTP je isto stikalo.

Podjetja na starem strežniku OptiRoutes

Podjetje, ki še dela s starim strežnikom OptiRoutes (WEB), lahko API uporablja za svoje podpisane POD: ustvarite ključ z dovoljenjem pod:read in uporabite /api/v1/pod, /api/v1/pod/archive in /api/v1/files/download?path=pod/…. Njegove druge datoteke se še naprej premikajo kot danes, dokler podjetje ne preide na novi strežnik.

Napake

Napaka vrne {"ok": false, "error": "<code>", "message": "<explanation>"}.

Omejitve

• 300 zahtev na minuto na ključ.
• 50 MB na datoteko.
• 20 aktivnih ključev na podjetje.
• Seznam mape vrne do 5.000 vnosov; za več navedite podmape (na primer en dan POD).

Pomoč

Vodja podjetja v Nastavitve → API in datoteke vidi vsak ključ, njegovo zadnjo uporabo in zadnje klice. Za vse drugo se obrnite na podporo OptiRoutes s številko podjetja in časom klica — nikoli ne pošiljajte samega ključa.