Soutien

Foire aux questions

Comment puis-je voir l’utilisation de mon API?

La page de votre application affiche le nombre de demandes d’API que votre application a faites.

Pour voir votre utilisation de l’API :

1. Sélectionnez Applications dans le menu principal.
2. Sélectionnez votre application.  
3. Dans le tableau des produits API, vous verrez tous les produits auxquels votre application a accès.

Pour chaque API à laquelle vous avez accès, vous pouvez comparer son utilisation à la limite de débit.

Comment puis-je tester une API?

Une fois que vous avez accès à un produit API, vous pouvez l’essayer dans votre navigateur sans configuration supplémentaire. Il vous suffit de sélectionner un point de terminaison, puis de sélectionner Essayer.

Pour essayer une interface API :

1. Sous l’onglet Essayer, sélectionnez l’identifiant API que vous avez généré pour une application dans le menu déroulant. Le champ Clé API s’affichera automatiquement (un seul identifiant s’affichera si vous n’avez pas créé plusieurs identifiants). Vous pouvez également saisir votre clé API manuellement dans le champ Clé API.

Remarque : Le portail ne vous donnera pas de code API secret. Vous devrez l’avoir sauvegardé lorsque vous créez une application. Vous pouvez réinitialiser votre clé API et code API secret dans les paramètres de l’application, au besoin.

2. Saisissez le code API secret associé.
3. Dans le champ Portées, cochez la case Commerçant.
4. Appuyez sur Générer un jeton pour assurer un accès adéquat.
5. Sélectionnez et modifiez vos paramètres.
6. Appuyez sur Envoyer et consultez la réponse fournie par le serveur.

Comment puis-je créer une application?

Les développeurs peuvent créer des applications à l’intérieur du portail. Elles leur permettent de demander des identifiants aux API disponibles. Une application peut avoir une ou plusieurs API, selon l’utilisation.

Les nouvelles utilisatrices et nouveaux utilisateurs doivent visiter la page des applications pour créer leur première application.

Les utilisatrices et utilisateurs actuels peuvent accéder directement à la section des applications pour utiliser une application existante ou en créer une nouvelle. Vous pouvez ajouter autant d’applications que nécessaire.

Après avoir créé une application, vous obtiendrez de nouveaux identifiants comprenant une clé API unique et un code API secret.

Remarque :

• Le code API secret ne s’affichera qu’une seule fois. Assurez-vous de le noter et de le conserver dans vos dossiers.
• Vous devez ouvrir une session pour voir l’option de menu des applis dans la barre de navigation supérieure.

Pour créer une nouvelle application : 

1. Sélectionnez Applications dans le menu de navigation supérieur.
2. Sélectionnez Créer une nouvelle application.
3. Sélectionnez un type d’application : Test ou Production¹. Remarque : Vous ne pouvez pas modifier le type d’application après la création.
4. Saisissez un nom d’application pertinent.
5. Ajoutez une description expliquant l’objectif de l’application (facultatif).
6. Sélectionnez Créer.

Conseil : Vous pouvez personnaliser votre application en ajoutant une image ou une icône après la configuration initiale.

¹ Les applications Test utilisent des données statiques ou simulées et ne déclenchent pas la facturation, ce qui les rend idéales pour la mise à l’essai de l’intégration. Les applications de Production utilisent des données réelles et génèrent des clés réelles. 

Une fois votre application créée, le système vous dirigera vers la section de l’application où vous pourrez commencer à ajouter des API. 

Remarque : Vous pouvez modifier ou supprimer une application en tout temps si elle n’est pas utilisée. 

Notes au sujet des identifiants API 

• Pour modifier ou réinitialiser vos identifiants ou votre code API secret, sélectionnez les trois points sous Identifiants dans la section des produits API et apportez les changements souhaités.
• Toute application peut avoir plusieurs identifiants.

Pour obtenir plus de renseignements sur les types de données d’identification prises en charge par Postes Canada, consultez le guide d’authentification.

Quelle est la différence entre une application de Test et une application de Production? Quelles sont les limites?

Les applications Test utilisent des données statiques ou simulées et ne déclenchent pas la facturation, ce qui les rend idéales pour la mise à l’essai de l’intégration. Les applications de Production utilisent des données réelles et génèrent des clés réelles.

Comment puis-je réinitialiser le code API secret de mon application?

Votre code API secret est chiffré, alors nous ne pouvons pas le récupérer si vous l’avez oublié. Vous pouvez toutefois le réinitialiser. La valeur stockée sera mise à jour et la nouvelle valeur vous sera retournée.

Pour réinitialiser votre code API secret :  

1. Sélectionnez Applications dans le menu principal.
2. Sélectionnez l’application en question.
3. Sélectionnez le lien Réinitialiser le code API secret dans le menu de la section Identifiants (à côté du bouton Ajouter un identifiant).
4. Sélectionnez Réinitialiser dans la fenêtre contextuelle.

Comment puis-je intégrer l’expédition de Postes Canada à mon site Web?

Le portail des développeurs de Postes Canada fournit un ensemble d’API que les développeuses et les développeurs peuvent connecter à notre système d’expédition. Se connecter et obtenez de la documentation complète, des échantillons de codes et des clés pour intégrer nos API à votre plateforme actuelle.  

Vous pouvez également communiquer avec des fournisseurs de solutions tiers approuvés qui ont déjà intégré les technologies de Postes Canada. Ces fournisseurs peuvent vous aider à simplifier le processus d’achat pour vous et votre clientèle en ligne.

J’ai des questions ou des problèmes avec un module d’extension d’expédition. Que dois-je faire?

Postes Canada compte sur des tiers pour créer des solutions d’interface avec son système. Nous n’avons pas de visibilité sur ces solutions et nous ne pouvons pas offrir un soutien direct à ce sujet.

Nous vous recommandons de communiquer avec le tiers développeur de la solution si vous avez des questions. Il doit être votre premier contact si un problème nécessite un dépannage.

S’il est déterminé que le problème provient de notre système, nous fournirons de l’aide au besoin.

Pourquoi l’étiquette indique-t-elle un poids différent de celui que j’ai soumis pour l’envoi?

Le poids sur la plupart de nos étiquettes est représenté par KG VE/EV, où EV signifie l’équivalent volumétrique. Il s’agit du poids volumétrique (cubique) du colis calculé à partir du poids et des dimensions indiqués dans votre demande.

Pourquoi mon manifeste créé dans l’environnement de développement n’affiche-t-il qu’un seul article?

Certaines données de l’environnement de test sont figées ou simulées, ce qui est donc un comportement attendu.