Sari la conținut
OperatorCompliance
Încearcă gratuit

Dezvoltatori

API de integrare

Un API JSON pentru a conecta propriile sisteme - TMS, tablouri de bord, foi de calcul sau instrumente de automatizare - la datele tale de conformitate. Orice cheie poate citi șoferii, vehiculele, alertele și rapoartele tahograf. O cheie cu permisiunea potrivită poate de asemenea să încarce fișiere tahograf și să descarce rapoarte și fișe de stare în PDF. Nimic altceva din API nu îți modifică datele.

Autentificare

API-ul este inclus în planurile Profesional şi Enterprise. Creaţi un cheie API în aplicaţie sub Setări > Integrare (doar pentru proprietari şi manageri de transport) şi trimiteţi-o ca un token bearer cu fiecare cerere. Cheia completă este afişată o singură dată când este creată, iar permisiunile sale sunt fixe atunci; revocaţi-o oricând.

curl https://operatorcompliance.co.uk/api/integration/v1/ping \
  -H "Authorization: Bearer oc_live_YOUR_KEY"

Limite de rată și paginare

Fiecare cheie poate face 60 de cereri pe minut, dintre care cel mult 30 de încărcări și descărcări PDF; peste o limită, API-ul răspunde cu 429. Listele sunt paginate cu ?page= și ?per_page= (implicit 50, maxim 100) și învelite în {data: [...], meta: {current_page, last_page, per_page, total}}.

Erori

Erorile sunt JSON cu un câmp message și, unde este util, un câmp code: 401 pentru o cheie lipsă, invalidă sau revocată, 402 când abonamentul contului nu este activ, 403 când planul sau permisiunile cheii nu acoperă cererea (code plan_feature sau missing_ability), 404 pentru o înregistrare care nu există în contul tău, 409 când un PDF nu este disponibil, 422 pentru date invalide (inclusiv un fișier care nu este o descărcare tahograf) și 429 când este atinsă o limită.

Puncte finale

GET /api/integration/v1/ping

Verificare conectivitate: confirmă că cheia funcționează și numele contului la care aparține.

Exemplu

{"ok": true, "operator": "Alpha Haulage Ltd", "time": "2026-08-29T10:15:00Z"}

GET /api/integration/v1/drivers

GET /api/integration/v1/drivers/{id}

Șoferii tăi cu datele lor de conformitate: statut, card tahograf, descărcări de carduri, statut licență și expirarea Driver CPC.

Câmpuri de răspuns

id, first_name, last_name, status, employed_from, tacho_card_number, tacho_card_expiry_on, last_card_download_on, next_card_download_due_on, licence_status, licence_valid_to, cpc_expiry_on

GET /api/integration/v1/vehicles

GET /api/integration/v1/vehicles/{id}

Vehiculele și remorcile tale: identitate, statut, date MOT și impozit, următoarea inspecție de siguranță, ultima descărcare a unității vehiculului și data limită pentru calibrarea tahografului.

Câmpuri de răspuns

id, identifier, display_identifier, vin, make, model, fleet_number, type, status, third_party, awaiting_review, mot_status, mot_expiry_on, tax_status, tax_due_on, next_si_due_on, last_vu_download_on, next_vu_download_due_on, tacho_calibration_due_on

GET /api/integration/v1/alerts?status=open|all

Alerte de conformitate. Alertele sunt deschise în mod implicit; adaugă ?status=all pentru a include cele recunoscute și rezolvate.

Câmpuri de răspuns

id, type, severity, status, title, message, due_on, created_at, alertable {type, id, label}

GET /api/integration/v1/tacho-reports

GET /api/integration/v1/tacho-reports/{id}

Rapoarte de încălcare a tahografului pe șofer și perioadă. Punctul final de detaliu include fiecare încălcare cu data, severitatea, regula și detaliile.

Câmpuri de răspuns

id, reference, driver {id, name}, period_from, period_to, status, infringement_count, highest_severity, sent_at, signed_at, created_at; detail adds infringements [{date, severity, rule, detail}]

Fișiere și PDF

Aceste puncte finale sunt incluse în planurile Professional și Enterprise. Fiecare necesită o cheie API cu permisiunea afișată alături, aleasă la crearea cheii. Lista fișierelor tahograf funcționează cu oricare dintre permisiuni.

POST /api/integration/v1/ddd-files

Permisiune: tacho:write

Încarcă o descărcare de pe cardul șoferului sau din unitatea vehiculului ca multipart/form-data în câmpul "file", de până la 20 MB. Trece prin aceleași verificări ca o încărcare în aplicație: conținutul trebuie să fie o descărcare tahograf (altfel 422 și nu se salvează nimic), un fișier deja existent în cont nu este salvat de două ori (200 cu duplicate true în loc de 201) și este pus în coadă pentru citire, potrivire cu șoferii și vehiculele tale și analiză.

Exemplu

curl https://operatorcompliance.co.uk/api/integration/v1/ddd-files \
  -H "Authorization: Bearer oc_live_YOUR_KEY" \
  -F "file=@driver-card.ddd"

GET /api/integration/v1/ddd-files

GET /api/integration/v1/ddd-files/{id}

Permisiune: tacho:write / reports:read

Fișierele tale tahograf și starea procesării lor, cele mai noi primele. Filtrează cu ?kind=driver_card|vehicle_unit, ?status=pending|parsed|failed și ?uploaded_since=YYYY-MM-DD. După o încărcare, interoghează punctul final de detaliu pentru a vedea când fișierul a fost citit.

Câmpuri de răspuns

id, kind, parse_status, parse_error, signature_valid, original_name, size, sha256, card_number, vrn, vin, driver {id, name}, vehicle {id, display_identifier}, period_from, period_to, download_time, uploaded_at; an upload adds duplicate

GET /api/integration/v1/tacho-reports/{id}/pdf

Permisiune: reports:read

Raportul tahograf în PDF: copia semnată de șofer, dacă există, altfel raportul așa cum a fost emis. Copiile stocate sunt verificate mai întâi cu suma de control înregistrată; un raport fără PDF sau a cărui copie nu trece această verificare răspunde cu 409.

GET /api/integration/v1/vehicles/{id}/status.pdf

GET /api/integration/v1/drivers/{id}/status.pdf

Permisiune: reports:read

Fișa de o pagină cu starea de conformitate a unui vehicul sau a unui șofer, ca în aplicație, în limba contului tău. Fișa șoferului din API nu include data nașterii și numărul permisului de conducere.

API-ul returnează doar date care aparțin contului pe care a fost creată cheia și nu returnează niciodată identificatori personali criptati, cum ar fi numerele de licență de conducere sau numerele de asigurare națională.

Pregătit să încetați să urmăriți datele?

Configurați într-o după-amiază. Mențineți licența operatorului curată pentru totdeauna.

Trial gratuit de 14 zile · fără card · anulează oricând