Skip to main content
Un jeton d’API permet à vos propres systèmes, ou à un développeur qui travaille pour vous, de se connecter à Zippendo : créer des expéditions, lire des commandes, enregistrer des webhooks et tout le reste décrit dans la référence de l’API. Vous créez les jetons sous Paramètres de l’API. Zippendo n’affiche le jeton complet qu’une seule fois, juste après sa création. Tour des paramètres : Paramètres, équipe et marques. Première requête : Démarrage rapide de l’API REST. Frais de livraison en caisse : Obtenir un devis d’expédition.
Toutes les formules incluent des jetons d’API : Free jusqu’à 2, Standard 5, Growth 10, Pro et Enterprise illimité. Une fois la limite atteinte, la création d’un jeton échoue avec Vous avez atteint la limite de votre formule. Changez de formule ou supprimez un élément que vous n’utilisez plus. Supprimez un jeton que vous n’utilisez plus, ou changez de formule.

​
Où le trouver

Ouvrez le menu de l’organisation en bas de la barre latérale, cliquez sur Gérer, puis sur l’onglet Paramètres de l’API. Le bouton pour créer un jeton est Ajouter un jeton d’API, en haut à droite.
Onglet Paramètres de l'API avec la liste des jetons d'API et Ajouter un jeton d'API dans l'en-têteOnglet Paramètres de l'API avec la liste des jetons d'API et Ajouter un jeton d'API dans l'en-tête

Jetons d'API : nom, début de chaque jeton, autorisations et dernière utilisation

​
La liste des jetons d’API

La seule action possible sur un jeton dans la liste est de le Supprimer. Vous ne pouvez ni modifier ni renommer un jeton. Sans jeton, la liste affiche Aucun jeton d’API et un bouton Créer votre premier jeton.

​
Créer un jeton

1

Ouvrir la fenêtre

Cliquez sur Ajouter un jeton d’API, ou sur Créer votre premier jeton lorsque la liste est vide. La fenêtre Créer un jeton d’API s’ouvre.
2

Nommer le jeton

Renseignez Nom du jeton *, par exemple « Warehouse WMS ». Vous pouvez aussi définir Expire dans (jours) et Limiter à une marque.
3

Choisir les autorisations

Cochez ce que le jeton peut faire, ou cliquez sur Tout sélectionner.
4

Le créer

Cliquez sur Créer le jeton. Vous voyez Jeton d’API créé, et Jeton d’API créé s’ouvre avec le jeton complet.
Fenêtre Créer un jeton d'API avec Nom du jeton, Expire dans (jours) et les cases d'autorisationsFenêtre Créer un jeton d'API avec Nom du jeton, Expire dans (jours) et les cases d'autorisations

Créer un jeton d'API : nom, expiration facultative, puis les autorisations

Créer le jeton reste grisé tant que le jeton n’a pas de nom et au moins une autorisation.

​
Autorisations

Chaque domaine a une autorisation de Lecture (Consulter les informations) et une autorisation d’Écriture (Créer, modifier et supprimer). Une autorisation d’Écriture inclut la Lecture du même domaine.
Autorisations de Créer un jeton d'API avec cases Lecture et Écriture, dont Tout voir et Tout modifierAutorisations de Créer un jeton d'API avec cases Lecture et Écriture, dont Tout voir et Tout modifier

Toutes les autorisations, avec Tout sélectionner activé

Les commandes, les canaux de vente, les imprimantes, les webhooks, les automatisations et les intégrations n’ont pas d’autorisation propre : un jeton qui en a besoin doit avoir Tout voir ou Tout modifier. Aucune des deux n’inclut les jetons d’API : cochez donc aussi Modifier les jetons d’API si le jeton doit créer ou supprimer d’autres jetons. Les mêmes autorisations sont utilisées pour les rôles personnalisés.

​
Copier le jeton (une seule fois)

Jeton d’API créé affiche le jeton complet, qui commence par zipp_. La fenêtre avertit : Copiez bien ce jeton. Vous ne pourrez plus le voir après avoir fermé cette fenêtre.
Fenêtre Jeton d'API créé avec le jeton, un bouton Copier et un avertissement ImportantFenêtre Jeton d'API créé avec le jeton, un bouton Copier et un avertissement Important

Jeton d'API créé : copiez le jeton avant de fermer la fenêtre

Cliquez sur Copier. Vous voyez Jeton copié dans le presse-papiers. Si vous voyez Impossible de copier le jeton, sélectionnez le jeton et copiez-le à la main. Fermez ensuite la fenêtre. Si vous perdez le jeton, supprimez-le et créez-en un nouveau.
Traitez le jeton comme un mot de passe. Ne le mettez pas dans un code que d’autres peuvent voir ni dans une page web. S’il fuite, supprimez-le (voir « Supprimer un jeton » ci-dessous) et créez-en un nouveau. Requêtes qui échouent : Erreurs d’authentification par jeton d’API.

​
Utiliser le jeton

Votre développeur envoie le jeton avec chaque requête :
{orgId} est l’ID de votre organisation, pas le nom affiché dans la barre d’adresse de l’application. Un développeur peut le lister avec les requêtes Orgs de la référence de l’API, où chaque requête et chaque réponse sont décrites. Clients prêts à l’emploi : SDK. Limites : Limites de débit. Un jeton sans marque peut cibler une marque pour une seule requête avec l’en-tête X-Zippendo-Brand. Un jeton créé avec Limiter à une marque reste toujours dans sa marque. Voir Marques.

​
Supprimer un jeton

Cliquez sur Supprimer sur la ligne du jeton. Supprimer le jeton d’API vous demande de saisir le nom du jeton en majuscules, par exemple WAREHOUSE WMS, puis de cliquer sur Supprimer. Vous voyez Jeton d’API supprimé. Tout système qui utilise le jeton ne peut plus se connecter. La suppression est irréversible, et il n’existe aucun moyen de mettre un jeton en pause à la place.
Fenêtre Supprimer le jeton d'API avec un champ pour saisir le nom à confirmerFenêtre Supprimer le jeton d'API avec un champ pour saisir le nom à confirmer

Supprimer le jeton d'API : saisissez le nom en majuscules pour confirmer

​
À lire aussi