Lue rajapintakuvaus, ennen kuin otat meihin yhteyttä.

Rajapintakuvaus puhuu puolestaan

Kaikki pyynnöstä ja vastauksesta — jokainen kenttä, sen tyyppi, onko se pakollinen, sisäkkäiset rakenteet, valmiit esimerkit, käytöstäpoistokäytäntö ja pyyntörajoitus — löytyy suoraan API:sta:

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

Kuvaus luodaan samoista malleista, jotka validoivat pyyntösi, joten se ei voi erkaantua siitä, mitä päätepiste hyväksyy. Siksi tämä sivu on myös lyhyt: kaikki, minkä kirjoittaisimme tähän uudelleen, olisi toinen kopio, ja kopiot vanhenevat.

Työn hinnoittelu

Pienin pyyntö, joka palauttaa hinnan:

curl -X POST https://cerrax-portal-api-zenqusyaia-nw.a.run.app/v1/price \
  -H "X-Cerrax-Api-Key: <avaimesi>" \
  -H "Content-Type: application/json" \
  -d '{
    "region": "fi",
    "volumeM3": 32.0,
    "distance": { "value": 77, "unit": "km" }
  }'

Anna distance (arvo ja yksikkö – tässä kilometreinä) tai molemmat postinumerot. Pääsy, säädöt, pakkaustaso, päivämäärät ja oma viitteesi ovat kaikki valinnaisia — ja kenttäopas osoitteessa /v1 luettelee jokaisen merkityksineen.

Mitä lupaamme ja mitä emme

• Sama työ palauttaa saman hinnan. Moottori on deterministinen ja versioitu; sama syöte ja sama moottoriversio tuottavat aina saman luvun, ja jokainen moottorin muutos julkaistaan päivättynä sivulla /kernel/changelog.
• Kentän lisääminen ei riko yhteensopivuutta; kentän poistaminen tarkoittaa uutta versiota. Koko käytöstäpoistokäytäntö ilmoitusaikoineen on rajapintakuvauksessa.
• Avain tunnistaa yrityksen. moverId-kenttää ei tarvitse välittää — et voi vahingossa hinnoitella jonkun toisen nimissä.
• Kenttä, jota emme hyväksy, hylätään — sitä ei ohiteta. Kirjoitusvirhe palauttaa 422-virheen, joka nimeää kentän, eikä hintaa, jossa lähettämäsi tieto on hiljaa jätetty huomiotta.
• Kun se ei tiedä, se sanoo sen. Epävarmat syötteet voidaan luvun sijaan ohjata ihmisen käsiteltäviksi. Annamme mieluummin rehellisen kieltäytymisen kuin itsevarman arvauksen.

Avaimen hankkiminen

Avaimet myönnetään yrityskohtaisesti keskustelun kautta — olemme varhaisessa vaiheessa ja haluamme mieluummin ymmärtää, mitä olet integroimassa, kuin jakaa tunnuksia massoittain. Kerro meille, mitä rakennat, niin vastaamme yhden arkipäivän kuluessa.

Mikään yllä olevista ei vaadi avainta. Jos jo rajapintakuvauksen lukeminen kertoo, ettei tämä sovi sinulle, se on hyvä lopputulos, ja se maksoi sinulle vain yhden curl-kutsun.