CRÉER UNE APPLICATION API SHIPPINGBO

1. Créer votre compte développeur

Pour pouvoir créer une application API Shippingbo sur votre compte Shippingbo, il vous faut en premier lieu créer votre compte développeur.

Vous pouvez le créer en vous rendant sur le Dashboard développeur ici.

2. Créer l'app

2.1 : Une fois votre compte développeur créé, cliquez sur le bouton "Create an application".

Puis, renseignez les informations suivantes :

- le nom de votre application

- votre redirect URI : la localisation vers laquelle le serveur d'autorisation renvoie l'utilisateur une fois l'application autorisée, ainsi qu'un code d'autorisation. Le serveur d'authentification envoie le code ou le token vers le redirect URI, c'est pourquoi vous devez enregistrer la localisation exacte lors du processus d'enregistrement de votre application. Le format doit être le suivant : https://...

Si vous souhaitez récupérer le token sur une page générique vierge, vous pouvez utiliser cet URL : urn:ietf:wg:oauth:2.0:oob

Puis, cliquez sur "Create" : 

 

3. Créer l'Authentification avec Oauth

3.1 : Cliquez sur Authorize pour autoriser la création de votre app :

3.2 : Obtenir le code d'autorisation nécessaire pour la première connexion API

Une fois l'application autorisée, le code d'autorisation s'affichera :

 

3.3 : Maintenant que vous avez le code d'autorisation, vous pouvez l'utiliser pour obtenir le token d'accès dans votre premier appel API :

Dans votre appel API renseignez :

• "autorization_code" dans le champ grant_type,

• votre code d'autorisation dans le champ code.

• votre id client et secret dans client_id et client_secret d'après les informations sur votre application :

Votre premier appel devrait ressembler à ceci, en curl : 

 

ou, en php : 

ou, en ruby : 

À partir de cette étape, vous n'aurez plus besoin de l'authorization code. Il ne sert qu'en clé d'accès pour obtenir les refresh_token et access_token.

 

4. Utiliser votre application API

4.1 : Utiliser l'access_token pour vous identifier dans vos appels.

 

4.2: Votre access_token expirera régulièrement. Pour renouveler votre access_token, vous pourrez utiliser votre refresh_token. Un nouveau refresh_token sera généré à chaque renouvellement.

Pour renouveler votre access_token, vous pourrez intégrer "refresh_token" dans l'appel "grant_type"

➡️ Plus d'informations dans la documentation API dédiée : Obtain an access token.

Exemple de requêtes, curl : 

php : 

ruby : 

4.3 : Faire une requête API à Shippingbo : 

Pour faire une requête API à Shippingbo, il faut inclure les en-têtes suivantes dans votre requête : 

• X-API-VERSION : version actuelle de l'API
• Authorization: Bearer 'votre access_token' : votre token d'identification
• X-API-ID : la valeur de votre app Shippingbo ID dans votre dashboard :

 

 

 

 

 

Nous contacter 📬:

Des questions à propos de cette fonctionnalité ?
N'hésitez pas à nous écrire ici afin que nous puissions répondre à vos questions.