Läs kontraktet innan du pratar med oss.

Kontraktet talar för sig självt

Allt om begäran och svaret — varje fält, dess typ, om det är obligatoriskt, de nästlade strukturerna, utförliga exempel, policyn för utfasning och anropsgränsen — levereras av API:et självt:

curl https://cerrax-portal-api-zenqusyaia-nw.a.run.app/v1

Det genereras från samma modeller som validerar din begäran, så det kan inte hamna i otakt med vad endpointen accepterar. Det är också därför den här sidan är kort: allt vi skrev av här skulle bli en andra kopia, och andra kopior blir inaktuella.

Att prissätta ett uppdrag

Den minsta begäran som ger ett pris:

curl -X POST https://cerrax-portal-api-zenqusyaia-nw.a.run.app/v1/price \
  -H "X-Cerrax-Api-Key: <your key>" \
  -H "Content-Type: application/json" \
  -d '{
    "region": "gb",
    "volumeM3": 32.0,
    "distanceMiles": 48.0
  }'

Ange distanceMiles eller båda postnumren. Åtkomst, justeringar, packningsnivå, datum och din egen referens är alla valfria — och fältguiden på /v1 listar varje fält med dess betydelse.

Vad vi lovar, och vad vi inte lovar

• Samma uppdrag ger samma pris. Motorn är deterministisk och versionerad; samma indata och samma motorversion ger alltid samma tal, och varje ändring av motorn publiceras med datum på /kernel/changelog.
• Ett nytt fält är ingen bakåtinkompatibel ändring; ett borttaget fält ger en ny version. Den fullständiga policyn för utfasning, inklusive varseltiden, finns i kontraktet.
• Nyckeln identifierar firman. Det finns inget moverId-fält att skicka med — du kan inte av misstag prissätta som någon annan.
• Ett fält vi inte accepterar avvisas i stället för att ignoreras. En felstavning ger felkod 422 med fältets namn, i stället för ett pris som i tysthet bortsåg från det du skickade.
• När den inte vet, säger den det. Osäkra indata kan skickas vidare till en människa i stället för att ge ett tal. Vi ger dig hellre ett ärligt avslag än en självsäker gissning.

Så får du en nyckel

Nycklar utfärdas per firma, i ett samtal — vi är i ett tidigt skede och vill hellre förstå vad du integrerar än dela ut inloggningsuppgifter i stor skala. Berätta vad du bygger så svarar vi inom en arbetsdag.

Inget av ovanstående kräver någon nyckel. Om det räcker att läsa kontraktet för att du ska se att det här inte passar är det ett bra utfall, och det kostade dig ett enda curl-anrop.