Leggi il contratto prima di parlarci.
Un solo endpoint prezza un lavoro. Il contratto che lo descrive è pubblico e non richiede chiavi — perché decidere se costruire sul prodotto di qualcuno è una cosa che dovresti poter fare da solo.
Il contratto parla da sé
Tutto ciò che riguarda richiesta e risposta — ogni campo, il suo tipo, se è obbligatorio, le strutture annidate, esempi completi, la politica di deprecazione e il limite di richieste — è servito dall’API stessa:
curl https://cerrax-portal-api-zenqusyaia-nw.a.run.app/v1È generato dagli stessi modelli che validano la tua richiesta, quindi non può disallinearsi da ciò che l’endpoint accetta. Per questo la pagina è corta: tutto ciò che ricopiassimo qui sarebbe una seconda copia, e le seconde copie invecchiano.
Prezzare un lavoro
La richiesta più piccola che restituisce un prezzo:
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
}'Indica distanceMiles oppure entrambi i codici postali. Accesso, rettifiche, livello di imballaggio, date e il tuo riferimento sono tutti facoltativi — e la guida ai campi su /v1 li elenca tutti con il loro significato.
Cosa promettiamo, e cosa no
- Lo stesso lavoro restituisce lo stesso prezzo. Il motore è deterministico e versionato; un dato input e una data versione producono sempre la stessa cifra, e ogni modifica è pubblicata con la data su /kernel/changelog.
- Aggiungere un campo non è una modifica incompatibile; toglierne uno comporta una nuova versione. La politica di deprecazione completa, preavviso compreso, è nel contratto.
- La chiave identifica l’impresa. Non c’è nessun campo
moverIdda passare — non puoi prezzare per conto di qualcun altro per errore. - Un campo che non accettiamo viene rifiutato, non ignorato. Un refuso restituisce un 422 che lo nomina, invece di un prezzo che ha ignorato in silenzio ciò che hai inviato.
- Quando non sa, lo dice. Gli input poco affidabili possono tornare inoltrati a una persona invece che con una cifra. Preferiamo darti un rifiuto onesto che un’ipotesi sicura di sé.
Ottenere una chiave
Le chiavi si rilasciano per impresa, parlandone — siamo agli inizi e preferiamo capire cosa stai integrando piuttosto che distribuire credenziali in massa. Raccontaci cosa stai costruendo e ti risponderemo entro un giorno lavorativo.
Niente di quanto sopra ne richiede una. Se leggere il contratto basta a dirti che non fa per te, è un buon risultato, e ti è costato un curl.