Article 6 sur 8

Ce que renvoie l'API

Du JSON, toujours la ressource complète, et un code d'erreur stable quand quelque chose bloque.

Les réponses

  • Créer une montre renvoie la montre, avec son watchId. C'est ce watchId (et non id) qu'on donne ensuite pour lier la carte.
  • Vérifier une carte (can-link-card) renvoie canLinkCard et un passportCheck : le niveau retenu, les champs manquants, les numéros de série déjà enregistrés.
  • Lier la carte renvoie le passeport créé, avec son numéro de carte (certificateCardId).
  • Lire un passeport renvoie toutes ses informations : la montre, ses photos, son niveau d'attestation, son statut de vol, sa garantie, son propriétaire tel que vous avez le droit de le voir.

Les listes sont paginées. Les libellés suivent la langue demandée dans l'en-tête accept-language (anglais par défaut).

Retrouver un passeport par votre référence

GET /certificates/by-external-ref/{ref} renvoie le passeport créé pour votre référence, la même réponse que GET /certificates/{certificateCardId}. Vous ne voyez que ce que vous avez créé. La recherche ignore la casse et les espaces, et une référence qui contient / s'encode en %2F.

Tant que la carte n'est pas liée, la réponse est 404 : GET /watches/by-external-ref/{ref} trouve la montre à toutes les étapes.

Les erreurs

Une erreur renvoie un code HTTP et, dans le corps, un code stable (code), un message dans la langue de la requête (message) et parfois des précisions (params). Lisez le code, pas le message, qui peut changer. Par exemple :

Code HTTPcodeCe que cela veut dire
422PASSPORT_INCOMPLETEIl manque des champs : params.missingFields les liste
409PASSPORT_SERIAL_ALREADY_REGISTEREDUn autre passeport de la manufacture a ce numéro de série
403PASSPORT_AUTHENTICATION_TYPE_NOT_ALLOWEDCe niveau d'attestation n'est pas ouvert à votre métier
400OWNERSHIP_PROFESSIONAL_OWNER_REFUSEDL'adresse déclarée comme propriétaire est celle d'un professionnel
Article suivantLe changement de propriétaire et le service après-vente