Utiliser les APIs de la plateforme pour en extraire des informations

Une API (Application Programming Interface) est un programme permettant à deux applications de communiquer et d'échanger des données. Les APIs de la plateforme sont privées et sécurisées : elles permettent de faire le lien entre vos données Rental et toute application tierce de votre choix.

Bon à savoir : pour une documentation complète sur l'authentification et l'utilisation de l'API (avec captures d'écran Swagger et Postman), consultez le guide technique : Documentation API Rental

1. Données disponibles via l'API

Données extractibles en GET :

• Catégories : liste et détails des catégories
• Produits : liste et détails des produits
• Clients : liste, détails par ID, détails par e-mail
• Points de vente : liste, détails par ID, locations par PDV, stocks par PDV, transactions par PDV
• Locations : liste et détails des locations
• Exports : paiements en caisse, paiements en ligne

Données injectables en POST :

• Créer un client
• Créer une location

2. Générer vos identifiants API

1. Rendez-vous au menu Outils > Clés API.

2. Cliquez sur "Créer des identifiants".

3. Renseignez le nom à associer à vos identifiants, puis cliquez sur "Sauvegarder". Votre ID client et votre clé secrète sont automatiquement générés.

4. Copiez l'ID client et la clé secrète : vous en aurez besoin pour obtenir un token d'accès.

Attention : la clé secrète n'est affichée qu'une seule fois. Conservez-la précieusement.

3. S'authentifier avec le header X-Access-Token

Le mode d'authentification standard est le header X-Access-Token.

Important : le passage du token en query string (?access_token=...) est supprimé et ne fonctionne plus. Le header Authorization: Bearer reste fonctionnel mais est déprécié — il est conseillé de migrer vers X-Access-Token.

5. Pour obtenir un token, appelez l'endpoint d'authentification :

POST /oauth/token

Transmettez votre client_id et votre client_secret pour recevoir un access_token en retour.

6. Pour chaque appel API, ajoutez le token dans le header HTTP :

X-Access-Token: <votre_access_token>

4. Tester via Swagger

7. Pour accéder à la documentation API Swagger de votre plateforme, ouvrez un ticket au support ZIQY pour obtenir vos accès (l'accès n'est pas disponible directement depuis le back-office pour des raisons de sécurité).

8. Dans Swagger, cliquez sur le bouton "Authorize".

9. Collez votre token dans le champ X-Access-Token affiché dans la pop-in, puis cliquez sur "Authorize".

10. Vous êtes maintenant authentifié. Votre token sera automatiquement transmis pour chaque appel effectué depuis Swagger.

11. Pour tester un endpoint (exemple : liste des catégories), dépliez le menu GET /categories et cliquez sur "Execute". La réponse s'affiche en dessous. Vous pouvez télécharger la réponse au format JSON en cliquant sur "Download".

12. Le détail du format des réponses (y compris les réponses en erreur) est disponible en bas de la documentation Swagger, sous la section "Schemas".

5. Tester via Postman

13. Dans Postman, ajoutez un header personnalisé à votre requête :

• Key : X-Access-Token
• Value : <votre_access_token>

14. Testez votre appel. Exemple pour la liste des catégories :

GET /openapi/v1/categories

Attention : une limite d'un appel par seconde est en place pour éviter les surcharges serveur.

6. Expiration des clés

15. Lors de la création de vos identifiants, vous pouvez consulter leur date d'expiration depuis Outils > Clés API.