Integracijos API

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

GET /api/integration/v1/ping

Ryšio patikrinimas: patvirtina, kad raktas veikia ir nurodo, kuriai paskyrai jis priklauso.

Pavyzdys

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

GET /api/integration/v1/drivers

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

Jūsų vairuotojai su jų atitikties datomis: statusas, tachografo kortelė, kortelių atsisiuntimai, licencijos statusas ir Driver CPC galiojimo pabaiga. Licencijos numeriai ir kiti asmeniniai identifikatoriai niekada nėra įtraukiami.

Atsakymo laukai

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}

Jūsų transporto priemonės ir priekabos: tapatybė, statusas, MOT ir mokesčių datos, artimiausia saugos patikra, paskutinio transporto priemonės vieneto atsisiuntimas ir tachografo kalibravimo terminas.

Atsakymo laukai

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

Atitikties įspėjimai. Atidaryti įspėjimai pagal numatytuosius nustatymus; pridėkite ?status=all, kad įtrauktumėte pripažintus ir išspręstus.

Atsakymo laukai

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}

Tachografo pažeidimų ataskaitos pagal vairuotoją ir laikotarpį. Detaliame pabaigos taške pateikiamas kiekvienas pažeidimas su jo data, sunkumu, taisykle ir detale.

Atsakymo laukai

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

POST /api/integration/v1/ddd-files

Leidimas: tacho:write

Įkelkite vieną vairuotojo kortelės arba transporto priemonės bloko atsisiuntimą kaip multipart/form-data lauke "file", iki 20 MB. Jis tikrinamas taip pat, kaip įkeliant programoje: turinys turi būti tachografo atsisiuntimas (kitaip 422 ir niekas neišsaugoma), jau paskyroje esantis failas neišsaugomas dukart (200 su duplicate true vietoj 201), ir jis įtraukiamas į eilę nuskaityti, susieti su jūsų vairuotojais ir transporto priemonėmis bei išanalizuoti.

Pavyzdys

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}

Leidimas: tacho:write / reports:read

Jūsų tachografo failai ir jų apdorojimo būsena, naujausi pirmi. Filtruokite su ?kind=driver_card|vehicle_unit, ?status=pending|parsed|failed ir ?uploaded_since=YYYY-MM-DD. Po įkėlimo užklauskite detalių pabaigos tašką, kad pamatytumėte, kada failas nuskaitytas.

Atsakymo laukai

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

Leidimas: reports:read

Tachografo ataskaita PDF formatu: vairuotojo pasirašyta kopija, jei ji yra, kitaip išduota ataskaita. Saugomos kopijos pirmiausia palyginamos su įrašyta kontroline suma; ataskaita be PDF arba su kopija, neišlaikiusia šio patikrinimo, atsako 409.

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

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

Leidimas: reports:read

Vieno puslapio transporto priemonės arba vairuotojo atitikties būsenos suvestinė, kaip programoje, jūsų paskyros kalba. Vairuotojo suvestinėje iš API nėra gimimo datos ir vairuotojo pažymėjimo numerio.