Izstrādātājiem

Pakomātu API un Webhooks

Visu, ko administrēšanas konsole dara ar sūtījumiem, var izdarīt arī caur versionētu REST API zem /api/v1, kas ir dokumentēts OpenAPI formātā.

REST API

01

Pakomāti

Pakomātu saraksts ar brīvajiem nodalījumiem pēc izmēra. Citu ražotāju pakomāti ir atzīmēti kā ārēji un ir tikai lasāmi.

02

Sūtījumi

Izveidojiet piegādes un nosūtīšanas, piešķiriet sūtījumu kurjeram vai kopīgajam sarakstam, atceliet sūtījumus un skatiet savācamo sūtījumu sarakstu.

03

Izsekošana un pierādījumi

Nolasiet pakomāta paziņotos izsekošanas notikumus un sūtījuma notikumus jaucējvērtību ķēdē kopā ar kurjera fotogrāfijām un piezīmēm.

04

Rezervācijas

Rezervējiet S, M vai L izmēra nodalījumu uz noteiktu laika logu. Sūtījums, kas izveidots ar šo rezervāciju, saņem tieši šo nodalījumu.

05

Atgriešana

Izveidojiet sūtījuma atgriešanu un saņemiet atgriešanas kodu.

06

Kurjera ielādes marķieris

Saņemiet parakstītu ielādes marķieri savai kurjeru lietotnei.

Atslēgas un ierobežojumi

API atslēgas izveido administrēšanas konsolē tikai ar nepieciešamajām tiesībām, piemēram, parcels:read vai parcels:write. Atslēgas tiek glabātas kā jaucējvērtības. Katrai atslēgai ir ierobežojums 10 pieprasījumi sekundē.

Webhooks

Abonējiet administrēšanas konsolē vai caur API. Notikumi: alert.opened, alert.resolved, parcel.created, parcel.status_changed, workorder.changed.

01

Parakstīti

Katrs pieprasījums satur laika zīmogu un HMAC-SHA256 parakstu, kas aprēķināts no laika zīmoga un pieprasījuma satura. Noraidiet visu, kas ir vecāks par 5 minūtēm.

02

Piegādāti pēc izmaiņu saglabāšanas

Transakciju izsūtnes (outbox) mehānisms nosūta notikumu tad un tikai tad, ja izmaiņas ir apstiprinātas. Neizdevušās piegādes tiek atkārtotas.

03

Droši galamērķi

Tikai HTTPS, bez pāradresācijām, privātās un īpašās adreses tiek bloķētas savienojuma brīdī. Darbojas ar Slack vai Teams.

Pakomāta izvēles logrīks

Pievienojiet /widget/lockers.js savai norēķinu lapai, lai parādītu pakomātus ar brīviem nodalījumiem. Logrīks nolasa publisku katra operatora pakomātu sarakstu, tāpēc pārlūkā netiek atklāta neviena API atslēga.

OpenAPI dokumentācija

Katrs galapunkts, shēma un tiesību apjoms ir aprakstīts OpenAPI failā, kas katrā instalācijā pieejams adresē /api/docs. Ģenerējiet no tā klientu savā programmēšanas valodā.

Citu ražotāju pakomātu attēlošana

Ja Jūsu pakomāti darbojas cita ražotāja mākonī, publicējiet tos kā vienkāršu JSON sarakstu: id, nosaukums, adrese, koordinātas, tiešsaistes statuss un brīvie nodalījumi pēc izmēra. Lokkio šo sarakstu nolasa ik pēc 5 minūtēm un parāda pakomātus tikai lasīšanas režīmā.

Saziņas līgums starp pakomātu un mākoni

Pakomāti sazinās ar mākoni caur mTLS, un katram pakomātam ir savs sertifikāts. Notikumi tiek sūtīti secīgi. Mākonis pārbauda jaucējvērtību ķēdi un apstiprina katru notikumu paketi. Ziņojumu līgumam ir versijas, un tas ir dokumentēts.

Saņemiet testa vides atslēgu

Izmēģiniet API ar demo pakomātu vai pieprasiet atslēgu savam integrācijas projektam.