ממשק הקבצים של אופטירוץ (API)

מה זה

לכל חברה באופטירוץ יש תיקיית קבצים פרטית משלה: ההזמנות שהיא טוענת, תעודות המשלוח החתומות (POD) עם התמונות והחתימות, ייצואי המסלולים ודוחות סוף היום. ממשק הקבצים מאפשר למערכות שלכם לקרוא ולכתוב בתיקייה הזו ישירות, בלי שרת FTP באמצע.

• כתובת: https://srv2.optiroutes.com/api/v1 — רק HTTPS.
• גישה: מפתח API שמנהל החברה יוצר בעצמו באופטירוץ, בהגדרות ← API וקבצים. לא צריך לפנות לתמיכה.
• כל סוגי הקבצים שהמערכת עובדת איתם היום: CSV, ‏JSON, ‏TXT, ‏XLSX/XLS, ‏PDF ותמונות.
• התשובות ב־JSON, חוץ מהורדת קובץ שמחזירה את הקובץ עצמו.

מתחילים ב־3 צעדים

1. יוצרים מפתח. באופטירוץ המנהל פותח הגדרות ← API וקבצים, לוחץ מפתח חדש, נותן שם (למשל "שרת ה־ERP"), בוחר הרשאות ומעתיק את המפתח. המפתח מוצג פעם אחת.
2. בודקים חיבור.

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

3. מורידים את ה־POD החתומים של היום בקובץ ZIP אחד:

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

אבטחה — חשוב לקרוא

• מתייחסים למפתח כמו לסיסמה. שומרים אותו בכספת סודות או במשתנה סביבה בשרת. לעולם לא בדף אינטרנט, באפליקציה, במייל, בקריאת שירות או בקוד שבגיט.
• מינימום הרשאות. לכל מערכת מפתח משלה עם ההרשאות שהיא צריכה בלבד: pod:read (רק POD חתומים), files:read (קריאת כל קבצי החברה), files:write (העלאת הזמנות וקבצים לתיבה).
• הגבלת כתובות. אם לשרת שלכם יש כתובת IP קבועה, מוסיפים אותה למפתח ("כתובות מורשות"). פנייה מכל כתובת אחרת נדחית.
• תוקף והחלפה. אפשר לתת למפתח תוקף בימים. כדי להחליף: יוצרים מפתח חדש, מעבירים אליו את המערכת, ואז מבטלים את הישן — בלי השבתה.
• מבטלים מייד מפתח שאולי דלף: הגדרות ← API וקבצים ← ביטול. הוא מפסיק לעבוד תוך 30 שניות.
• מעקב. כל פנייה נרשמת (זמן, כתובת, קובץ, תשובה) ומוצגת למנהל באותו מסך.
• אופטירוץ שומרת רק טביעת אצבע (SHA-256) של כל מפתח, אף פעם לא את המפתח עצמו. החיבור רק ב־HTTPS (‏TLS 1.2 ומעלה).
• מפתח מגיע רק לתיקייה של החברה שלו. אי אפשר להגיע לקבצים של חברה אחרת או לתיקיות הפנימיות של המערכת.

הזדהות

שולחים את המפתח בכל בקשה, באחת מהכותרות האלה:

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

מפתח נראה כך: opr_2813_… (מספר החברה, ואחריו 32 תווים אקראיים).

התיקייה של החברה

הפניות האפשריות

דוגמה לתשובה של רשימה:

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

משימות נפוצות

העלאת קובץ ההזמנות של היום

# 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"

אופטירוץ טוענת את הקובץ כמו היום (הטעינה האוטומטית של הגדרות ← טעינה, או "טעינת קובץ" של המשתמש).

הורדת ה־POD החתומים של הזמנה אחת

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"

הורדת דוח סוף היום

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

לעבוד כמו ב־FTP — סקריפט סנכרון תיקייה

מי שעבד עם FTP יכול להחזיק תיקייה בשרת שלו מסונכרנת עם התיקייה של החברה: משימה מתוזמנת מורידה קבצים חדשים (למשל ה־POD) ומעלה את הקבצים שמניחים בתיקייה מקומית. סקריפט ה־PowerShell שלמטה עושה את שניהם; מריצים אותו כל כמה דקות מ־Task Scheduler של Windows (בלינוקס — שורות ה־curl עם 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
}

מעבר של חברה מ־FTP ל־API

המנהל מעביר בהגדרות ← API וקבצים ← הקבצים עוברים דרך: API. מאותו רגע לא נשלח כלום ל־FTP של החברה, וכל קובץ נמצא במקום זה בתיקייה של החברה:

חברות חדשות עובדות עם ה־API מההתחלה. חזרה ל־FTP — באותו מתג.

חברות שעובדות מול השרת הישן

חברה שעדיין עובדת מול השרת הישן של אופטירוץ (WEB) יכולה להשתמש ב־API לתעודות ה־POD החתומות: יוצרים מפתח עם ההרשאה pod:read ומשתמשים ב־/api/v1/pod, ‏/api/v1/pod/archive ו־/api/v1/files/download?path=pod/…. שאר הקבצים ממשיכים לעבור כמו היום, עד שהחברה עוברת לשרת החדש.

שגיאות

שגיאה מחזירה {"ok": false, "error": "<code>", "message": "<explanation>"}.

מגבלות

• 300 פניות בדקה לכל מפתח.
• עד 50MB לקובץ.
• עד 20 מפתחות פעילים לחברה.
• רשימת תיקייה מחזירה עד 5,000 פריטים; לרשימה גדולה יותר — פונים לתת תיקייה (למשל יום אחד של POD).

עזרה

מנהל החברה רואה כל מפתח, את השימוש האחרון בו ואת הפניות האחרונות בהגדרות ← API וקבצים. לכל דבר אחר — פונים לתמיכה של אופטירוץ עם מספר החברה והשעה של הפנייה. לעולם לא שולחים את המפתח עצמו.