Evyoo POS API v1

Télécharger

Deux fichiers, générés à partir du code de l'API : ils sont toujours à jour avec ce site.

FichierPour quoi faire
Collection PostmanEssayer l'API en cliquant, sans écrire de code.
Description OpenAPILa description complète de l'API au format standard : pour générer un client dans votre langage, ou l'ouvrir dans un outil de documentation.

Utiliser la collection Postman#

  1. Dans Postman, cliquez sur Import et choisissez le fichier de la collection (ou collez son adresse).
  2. Ouvrez la collection, onglet Variables, et remplissez trois valeurs : baseUrl (l'adresse de votre entreprise, avec /api/v1 à la fin), clientId (votre clé d'accès) et clientSecret (votre code de sécurité). Enregistrez.
  3. Lancez la requête Get an access token. Le jeton est rangé tout seul dans la collection (variable accessToken) et expire au bout de 15 minutes : relancez cette requête quand il expire.
  4. Lancez n'importe quelle autre requête. Elles envoient le jeton toutes seules.

Par exemple, baseUrl vaut :

text
https://votre-entreprise.evyooht.com/api/v1

Dans chaque requête de liste, page et per_page sont cochés ; les filtres sont décochés : cochez ceux que vous voulez essayer (la case à gauche de chaque paramètre), et changez leur valeur.

Utiliser la description OpenAPI#

Le fichier openapi.json suit la norme OpenAPI 3.0. Il décrit chaque endpoint, chaque paramètre, chaque champ de réponse et l'authentification. Vous pouvez :

  • l'ouvrir dans un outil comme Swagger Editor, Insomnia ou Postman ;
  • générer un client dans votre langage avec un générateur de code OpenAPI ;
  • l'utiliser pour valider les réponses dans vos tests.