Commencer

Suivez ces étapes simples pour commencer à utiliser nos API.

Trouvez la solution idéale pour votre entreprise

Parcourez nos API et passez en revue leurs descriptions fonctionnelles et techniques. Choisissez ensuite la bonne interface API pour votre site Web ou plateforme de cybercommerce.

Ouvrez un compte gratuit (ou une session si vous en avez déjà un)

Si vous avez déjà un compte de Postes Canada, pour commencer à intégrer vos API préférés.

Si vous n’avez pas déjà un compte Postes Canada, il vous suffit d’en ouvrir un maintenant. Cela ne prend que quelques minutes, et c’est gratuit!

Pour créer un nouveau compte :

  1. Établissez un profil d’entreprise de Postes Canada. Si vous avez déjà un numéro de client, inscrivez-vous avec ce numéro et votre code postal. Si vous n’avez pas de numéro de client, inscrivez-vous en ligne pour en obtenir un.
  2. Ajoutez vos coordonnées, votre nom d’utilisateur, votre mot de passe et vos renseignements commerciaux.
  3. Créez une question de sécurité.
  4. Acceptez les modalités du profil de Postes Canada.
  5. Sélectionnez S’inscrire.
  6. Vérifiez si vous avez reçu un courriel de confirmation.

  7. Acceptez les modalités du portail des développeurs.

    Remarque : Vous devez accepter ces modalités avant d’avoir l’autorisation d’ouvrir une session dans votre nouveau compte.

Si vous avez plusieurs numéros de client dans votre compte

Si votre compte est associé à plusieurs numéros de client, le portail des développeurs vous offre un moyen facile de gérer l’organisation pour laquelle vous agissez à tout moment.

Ouverture de session initiale et facturation

Lorsque vous ouvrez une session dans le portail des développeurs pour la première fois avec un compte lié à plusieurs numéros de client, on vous invitera à sélectionner un seul numéro pour continuer.

Il est important de choisir soigneusement. Le numéro de client que vous sélectionnez devient l’organisation active pour votre session. Cette sélection dicte la facturation. Tous les appels d’API qui entraînent des frais, comme la Créer un envoi, sont facturés au numéro de client associé à la clé API utilisée pour la demande, peu importe votre session actuelle sur le portail.

Inscription d’autres organisations

Si vous avez plusieurs numéros de client et que vous souhaitez en utiliser un qui n’a pas encore été configuré dans le portail, vous n’avez pas besoin de créer un nouveau compte.

Pour inscrire d’autres organisations :
  1. Sélectionnez Inscrire une organisation dans la liste déroulante des organisations.
  2. Choisissez le numéro de client supplémentaire que vous souhaitez ajouter à partir de la liste disponible dans votre compte.
  3. Suivez les directives pour terminer l’inscription pour ce numéro de client précis.

Passer d’une organisation à une autre

Une fois que vous avez enregistré plusieurs numéros de client, vous pouvez facilement passer d’un à l’autre.

Pour ce faire, choisissez Sélectionner l’organisation dans la barre de navigation supérieure. Vous recevrez une liste de toutes les organisations inscrites auxquelles vous avez accès.

Créez une application et obtenez vos identifiants API.

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 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.

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.
  • 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.

Ajouter des produits API

Vous pouvez ajouter des produits API à votre application nouvellement créée. Sélectionnez le bouton Ajouter un produit d’API pour ajouter une API.

Vous pouvez également accéder aux produits API lorsque vous naviguez dans la documentation de l’API en sélectionnant Accéder sur n’importe quelle page d’aperçu ou de référence API.

Pour ajouter des produits API à partir d’une application :

  1. Sélectionnez Ajouter un produit d’API dans la section des produits API.
  2. Choisissez un produit API.
  3. Sélectionnez Accéder.
  4. Confirmez l’ajout du produit API à l’application.
  5. Répétez les étapes pour ajouter d’autres produits API à l’intérieur de l’application.

Pour ajouter des produits API à partir d’une page de documentation :

  1. Parcourez le catalogue des API pour en apprendre davantage sur les produits API individuels.
  2. Visitez la page d’aperçu de l’API ou la page de références de l’API.
  3. Sélectionnez Accéder.
  4. Confirmez l’ajout du produit API à l’application.

Essayez l’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.

  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 Appuyez sur Envoyer et consultez la réponse fournie par le serveur.

Explorez les documents

L’heure est à l’intégration? Nos documents détaillés vous aideront à comprendre et à utiliser rapidement nos produits d’API.

Encore besoin d’aide?

Lisez notre FAQ ou communiquez avec notre équipe de spécialistes pour obtenir plus de soutien.

Obtenez du soutien