Articolo 6 di 8

Cosa restituisce l'API

JSON, sempre la risorsa completa, e un codice di errore stabile quando qualcosa blocca.

Le risposte

  • Creare un orologio restituisce l'orologio, con il suo watchId. È questo watchId (non id) che si indica poi per collegare la carta.
  • Verificare una carta (can-link-card) restituisce canLinkCard e un passportCheck: il livello applicato, i campi mancanti, i numeri di serie già registrati.
  • Collegare la carta restituisce il passaporto creato, con il suo numero di carta (certificateCardId).
  • Leggere un passaporto restituisce tutte le sue informazioni: l'orologio, le sue foto, il suo livello di autenticazione, il suo stato di furto, la sua garanzia, il suo proprietario come hai il diritto di vederlo.

Gli elenchi sono paginati. Le etichette seguono la lingua richiesta nell'intestazione accept-language (inglese per impostazione predefinita).

Ritrovare un passaporto con il tuo riferimento

GET /certificates/by-external-ref/{ref} restituisce il passaporto creato per il tuo riferimento, la stessa risposta di GET /certificates/{certificateCardId}. Vedi solo ciò che hai creato. La ricerca ignora maiuscole e spazi, e un riferimento che contiene / si codifica come %2F.

Finché la carta non è collegata, la risposta è 404: GET /watches/by-external-ref/{ref} trova l'orologio in ogni fase.

Gli errori

Un errore restituisce un codice HTTP e, nel corpo, un codice stabile (code), un messaggio nella lingua della richiesta (message) e a volte dei dettagli (params). Leggi il codice, non il messaggio, che può cambiare. Per esempio:

Codice HTTPcodeCosa significa
422PASSPORT_INCOMPLETEMancano dei campi: params.missingFields li elenca
409PASSPORT_SERIAL_ALREADY_REGISTEREDUn altro passaporto della manifattura ha questo numero di serie
403PASSPORT_AUTHENTICATION_TYPE_NOT_ALLOWEDQuesto livello di autenticazione non è aperto alla tua attività
400OWNERSHIP_PROFESSIONAL_OWNER_REFUSEDL'indirizzo dichiarato come proprietario è quello di un professionista
Articolo successivoIl cambio di proprietario e l'assistenza post-vendita