Prijs-API

Lees het contract voordat u met ons praat.

Eén endpoint prijst een klus. Het contract dat het beschrijft is openbaar en heeft geen sleutel nodig — want of u op iemands product wilt bouwen, moet u zelf kunnen beslissen.

Het contract spreekt voor zichzelf

Alles over het verzoek en het antwoord — elk veld, het type, of het verplicht is, de geneste structuren, uitgewerkte voorbeelden, het uitfaseerbeleid en de limiet — levert de API zelf:

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

Dat wordt gegenereerd uit dezelfde modellen die uw verzoek valideren, dus het kan niet afwijken van wat het endpoint accepteert. Daarom is deze pagina kort: alles wat we hier zouden overtypen is een tweede kopie, en tweede kopieën verouderen.

Een klus prijzen

Het kleinste verzoek dat een prijs oplevert:

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

Geef distanceMiles of beide postcodes. Toegang, correcties, inpakniveau, data en uw eigen referentie zijn allemaal optioneel — en de veldengids op /v1 noemt ze allemaal met hun betekenis.

Wat we beloven, en wat niet

Dezelfde klus geeft dezelfde prijs. De engine is deterministisch en geversioneerd; een gegeven invoer en versie geven altijd hetzelfde getal, en elke wijziging wordt met datum gepubliceerd op /kernel/changelog.
Een veld toevoegen is geen brekende wijziging; een veld weghalen krijgt een nieuwe versie. Het volledige uitfaseerbeleid, inclusief de opzegtermijn, staat in het contract.
De sleutel identificeert het bedrijf. Er is geen veld moverId om mee te sturen — u kunt niet per ongeluk als iemand anders prijzen.
Een veld dat we niet accepteren, wordt geweigerd, niet genegeerd. Een typfout geeft een 422 die hem noemt, in plaats van een prijs die stilletjes negeerde wat u stuurde.
Als hij het niet weet, zegt hij dat. Onzekere invoer kan terugkomen als doorgezet naar een mens in plaats van een getal. We geven u liever een eerlijke weigering dan een zelfverzekerde gok.

Een sleutel krijgen

Sleutels worden per bedrijf uitgegeven, in een gesprek — we zijn jong en begrijpen liever wat u integreert dan dat we op grote schaal inloggegevens uitdelen. Vertel ons wat u bouwt en we antwoorden binnen één werkdag.

Niets hierboven vereist er een. Als het lezen van het contract u al vertelt dat het niet past, is dat een goede uitkomst, en het kostte u één curl.