Kūrėjai
Integracijos API
Skaitymo tik API JSON, skirtas jūsų atitikties duomenims gauti į savo sistemas: TMS, informacinius skydelius, skaičiuokles ar automatizavimo įrankius. Viskas yra tik GET - API niekada nekeičia jūsų duomenų.
Autentifikacija
Sukurkite API raktą programoje skiltyje Nustatymai > Integracijos (tik savininkams ir transporto vadybininkams) ir siųskite jį kaip nešėją su kiekvienu užklausimu. Pilnas raktas rodomas vieną kartą, kai jis sukuriamas; bet kada galite jį atšaukti.
curl https://operatorcompliance.co.uk/api/integration/v1/ping \
-H "Authorization: Bearer oc_live_YOUR_KEY"Greitųjų ribos ir puslapiavimas
Kiekvienas raktas gali atlikti 60 užklausų per minutę; viršijus limitą API atsako 429. Sąrašai puslapiuojami su ?page= ir ?per_page= (numatytas 50, maksimalus 100) ir apvynioti į {data: [...], meta: {current_page, last_page, per_page, total}}.
Klaidos
Klaidos yra JSON su pranešimo lauku: 401 už trūkstamą, neteisingą ar atšauktą raktą, 404 už įrašą, kuris neegzistuoja jūsų paskyroje, 429 kai pasiektas greičio limitas.
Pabaigos taškai
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, 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}]
API visada grąžina tik duomenis, priklausančius paskyrai, kuriai raktas buvo sukurtas, ir niekada negrąžina užšifruotų asmeninių identifikatorių, tokių kaip vairuotojo licencijos numeriai ar Nacionalinio draudimo numeriai.
Pasiruošę nustoti sekti datas?
Sukurkite per popietę. Išlaikykite savo operatoriaus licenciją švarią visam laikui.
14 dienų nemokamas bandomasis laikotarpis · jokių kortelių · atšaukite bet kada