Article 3 sur 8

La documentation et l'accès de test

Une référence complète de l'API, et un compte de test prêt à l'emploi, pour l'essayer sans risque.

La référence

La référence de l'API (au format OpenAPI, consultable dans Swagger) décrit chaque appel ouvert aux professionnels : ses paramètres, ses réponses, ses exemples et ses codes d'erreur. Elle couvre :

  • les montres et les passeports : création, modification, photos, liaison de la carte ;
  • les propriétaires : déclaration à la vente, changement de propriétaire ;
  • l'historique et la garantie d'un passeport ;
  • vos détaillants et vos centres de service, et votre stock chez eux ;
  • la commande d'une certification.

Elle est ouverte, sans identifiants, à l'adresse https://api.watchcertificate.org/api/v1/doc.

L'accès de test

Nous ouvrons pour vous un compte sur notre environnement de test, séparé de la production. Il contient :

  • un compte professionnel validé, avec son mot de passe ;
  • sa clé API ;
  • un lot de cartes de test, avec leur numéro et leur code ;
  • des crédits, pour lier ces cartes ;
  • un passeport d'exemple, pour voir à quoi ressemble le résultat.

Les cartes de test n'existent que sur l'environnement de test : en production, chaque carte est une carte physique, livrée avec la montre.

Passer en production

Les appels sont les mêmes. Vous créez une clé API sur votre compte de production, vous changez l'adresse de l'API, et vous utilisez vos vraies cartes.

Article suivantQui appelle qui