Paštomatai
Paštomatų sąrašas su laisvomis durelėmis pagal dydį. Kitų gamintojų paštomatai pažymimi kaip išoriniai ir prieinami tik skaitymui.
Kūrėjams
Paštomatų API ir webhooks
Viską, ką administravimo konsolė daro su siuntomis, galima atlikti per versijuojamą REST API adresu /api/v1, aprašytą OpenAPI formatu.
REST API
Siuntos
Kurkite pristatymus ir išsiuntimus, priskirkite siuntą kurjeriui arba bendram sąrašui, atšaukite siuntas ir gaukite paimtinų siuntų sąrašą.
Sekimas ir įrodymai
Skaitykite paštomato pateiktus sekimo įvykius ir maišos grandine susietus siuntos įvykius su kurjerio nuotraukomis ir pastabomis.
Rezervacijos
Rezervuokite S, M arba L dydžio dureles pasirinktam laiko intervalui. Su rezervacija sukurtai siuntai skiriamos būtent tos durelės.
Grąžinimai
Sukurkite siuntos grąžinimą ir gaukite grąžinimo kodą.
Kurjerio įdėjimo žetonas
Gaukite pasirašytą įdėjimo žetoną savo kurjerių programėlei.
Raktai ir apribojimai
API raktai kuriami administravimo konsolėje tik su reikalingomis teisėmis, pavyzdžiui, parcels:read arba parcels:write. Raktai saugomi kaip maišos reikšmės. Kiekvienam raktui leidžiama ne daugiau kaip 10 užklausų per sekundę.
Webhooks
Prenumeruokite administravimo konsolėje arba per API. Įvykiai: alert.opened, alert.resolved, parcel.created, parcel.status_changed, workorder.changed.
Pasirašyti
Kiekvienoje užklausoje yra laiko žyma ir HMAC-SHA256 parašas, apskaičiuotas iš laiko žymos ir turinio. Atmeskite užklausas, senesnes nei 5 minutės.
Siunčiami tik išsaugojus pakeitimą
Transakcinis „outbox“ mechanizmas išsiunčia įvykį tada ir tik tada, kai pakeitimas įrašytas. Nepavykę pristatymai kartojami.
Saugūs adresatai
Tik HTTPS, be peradresavimų. Privatūs ir specialieji adresai blokuojami jungimosi metu. Veikia su Slack arba Teams.
Paštomato pasirinkimo valdiklis
Įtraukite /widget/lockers.js į atsiskaitymo puslapį, ir pirkėjai matys paštomatus su laisvomis durelėmis. Valdiklis skaito viešą operatoriaus paštomatų sąrašą, todėl naršyklėje neatskleidžiamas joks API raktas.
OpenAPI dokumentacija
Kiekvienas galinis taškas, schema ir teisių sritis aprašyti OpenAPI faile, kuris kiekvienoje diegimo vietoje pasiekiamas adresu /api/docs. Pagal jį sugeneruokite klientą savo programavimo kalba.
Kitų gamintojų paštomatų rodymas
Jei Jūsų paštomatai veikia kito gamintojo debesyje, pateikite juos paprastu JSON sąrašu: id, pavadinimas, adresas, koordinatės, prisijungimo požymis ir laisvos durelės pagal dydį. Lokkio šį sąrašą nuskaito kas 5 minutes ir rodo tik peržiūrai.
Paštomato ir debesies sąsajos sutartis
Paštomatai su debesimi jungiasi per mTLS, kiekvienas paštomatas turi savo sertifikatą. Įvykiai siunčiami eilės tvarka, debesis tikrina maišos grandinę ir patvirtina kiekvieną paketą. Pranešimų sutartis versijuojama ir dokumentuota.
Gaukite bandomosios aplinkos raktą
Išbandykite API su demonstraciniu paštomatu arba paprašykite rakto savo integracijos projektui.