Guides du Magasin des APIs

Démarrage rapide

Étape

Description

Référence

1

Parcourez le magasin des API pour déterminer les API que vous souhaitez utiliser pour vos applications.

https://api.canada.ca/fr

2

Créer un compte dans le magasin des API en vous enregistrant.

How do I get access to the API Store?

3

Sélectionner une API et inscrivez-vous à son plan.

How do I subscribe to an API?

4

Tester l’API.

How do I test an API before I subscribe to it?

5

Invoquer l’API depuis votre application.

How do I call an API?

Comment puis-je accéder à l'API Store?

Pour utiliser une API dans le magasin des API, vous devez avoir un compte.

  1. Dans la page principale du magasin des API, cliquez sur Enregistrer/Connexion.
  2. Cliquez sur Enregistrer. La page S'enregistrer dans le magasin des API s'ouvre.

  1. Entrez vos informations d'identification et cliquez sur Enregistrer. Un courriel de confirmation vous sera envoyé par l'administrateur.
  2. Cliquez sur le lien dans le courriel. Cliquez sur le lien sur la page pour vérifier. La page de connexion de l'utilisateur s'ouvre dans votre navigateur.

  1. Tapez vos informations d’authentification et cliquez sur Connexion.

Comment s’abonner à une API?

Avant de pouvoir utiliser une API, vous devez vous abonner à un plan d'API. Le plan détermine le nombre d'appels d'API que votre application peut effectuer. Certains plans nécessitent une approbation. Pensez à ce dont vous avez besoin et choisissez le plan le plus approprié. Une fois que votre application est abonnée à un plan, une clé d'utilisateur unique (le paramètre user_key) est attribuée à l'application. Vous devez utiliser cette clé utilisateur lorsque vous appelez l’API.

  1. Connectez-vous au magasin des API.
  2. Sélectionnez le lien de la liste des API dans le menu déroulant en haut de la page.
  3. Sélectionnez l'API que vous souhaitez utiliser pour votre application. La page des détails de l'API s'ouvre.
  4. Cliquez sur l'onglet Plans, puis sur le bouton S’abonner à ce plan pour le plan que vous avez choisi. La fenêtre d’abonnement à API s'ouvre.

 

  1. Dans les zones Nom et Description, entrez les informations de votre application (voir l'exemple ci-dessus).
  2. Cliquez sur S’abonner. La page Sommaire d'abonnement s'ouvre.

  1. Notez la clé d'utilisateur afin de pouvoir l'utiliser dans vos appels d'API.

Vous pouvez utiliser l'abonnement après que votre administrateur vous ait envoyé un courrier électronique indiquant que votre demande a été approuvée.

Comment obtenir une clé utilisateur pour une application?

  1. Connectez-vous au magasin des API.
  2. Sélectionnez le lien Abonnements en haut à droite de la page. La page Mes abonnements répertorie vos abonnements.
  3. Sélectionnez l'application. La page d'informations sur les abonnemenets s'ouvre.
  4. Voir la section Clé utilisateur. C'est la clé utilisée dans les appels d'API à votre application.

Comment regénérer la clé utilisateur pour une application?

  1. Connectez-vous au magasin des API.
  2. Sélectionnez l'onglet d'abonnements en haut de la page.
  3. Sélectionnez votre application. La page Détails de l'application s'ouvre.
  4. Dans la section Clé utilisateur, cliquez sur .

  5. Notez la clé d'utilisateur pour pouvoir l'utiliser dans les appels d'API.

Comment utiliser la clé utilisateur?

La clé utilisateur doit être passée dans l'en-tête plutôt que dans l'URI, comme indiqué dans l'exemple ci-dessous.

curl –-header 'user-key: 115aaa43e7d95df63d62eecbfab21e8x' 'https://cipo-gsm-ised-isde-apicast-production.api.canada.ca/app/scr/api/cgs/classes'
  • Utilisez l'option -H ou –header.
  • Remplacez la clé utilisateur par la clé utilisateur figurant dans la page d'abonnements du magasin des API dans la section Clé utilisateur.

Comment tester une API REST avant de s’y abonner?

  1. Connectez-vous au magasin des API.
  2. Sélectionnez le lien de la liste des API dans le menu déroulant en haut de la page.
  3. Sélectionnez l'API. La page des détails de l'API s'ouvre.
  4. Développez les opérations de l'API en cliquant sur l'opération (par exemple, GET) ou sur Détail des opérations.
  5. Entrez les paramètres requis dans les zones Valeur.
  6. Cliquez sur Essayez!