API ouvertes de Shipturtle
Guide d'utilisation des API Shipturtle
Dans ce guide, nous vous expliquerons les étapes d'utilisation de l'API Shipturtle.
Vous pouvez accéder à notre documentation sur l'API ici —
https://documenter.getpostman.com/view/30688585/2s9YkgBjCr
Les jetons d'accès sont essentiels pour interagir avec l'API de Shipturtle, car ils authentifient et autorisent les utilisateurs, garantissant ainsi un accès sécurisé à nos services. Cette section vous guide tout au long du processus d'obtention d'un jeton d'accès, vous permettant de commencer à tirer parti des fonctionnalités de l'API.
Conditions préalables à l'utilisation des API
Pour accéder à la fonctionnalité de INTÉGRATION DE L'API, vous devrez utiliser le module complémentaire API Integration. Accédez à Paramètres> Abonnement et facturation.
Création d'un jeton d'accès
1. Accédez à la section Intégration des API :
Sur le tableau de bord Shipturtle, accédez à « Intégration de l'API ».
2. Créez un nouveau jeton d'accès :
Cliquez sur « Créer un jeton d'accès ».
3. Configurez les paramètres du jeton d'accès :
- Définissez le « nom d'utilisateur » et le « mot de passe ».
- Choisissez les autorisations d'accès à l'API dont vous avez besoin : « Accès à l'API de commande », « Accès à l'API du produit », ou les deux.
4. Générez le jeton d'accès :
- Cliquez sur « Créer un jeton d'accès ».
- Copiez le jeton d'accès généré.
5. Partagez le jeton d'accès :
Fournissez le jeton d'accès copié à votre développeur.
Révocation d'un jeton d'accès
1. Lancez le processus de révocation :
- Dans la section Intégration de l'API, recherchez le jeton que vous souhaitez révoquer.
- Cliquez sur le « bouton Supprimer » dans la colonne « Action ».
2. Confirmez la révocation :
Cliquez sur le bouton « révoquer » pour désactiver le jeton.
Remarque : Une fois qu'un jeton d'accès à l'API est révoqué, il est immédiatement désactivé. Toute demande d'API utilisant ce jeton sera rejetée, ce qui peut entraîner l'échec des systèmes qui en dépendent. Après la révocation, le jeton d'API ne sera plus visible.
