Assistance

Un plan est une collection de ressources d'API ou de sous-ensembles de ressources provenant d'une ou plusieurs API. Il peut contenir différents types d'opération issus de diverses API. Un plan peut avoir une limite de débit commune pour toutes les ressources ou chaque ressource peut avoir une limite de débit particulière. Les limites de débit spécifient le nombre de requêtes qu'une application est autorisée à effectuer pendant un intervalle de temps donné.

Utilisez ce portail développeur pour parcourir les différents forfaits qui vous sont proposés et sélectionner celui qui correspond le mieux à vos besoins. Certains plans ont un accès restreint et vous devez demander un droit d'accès pour les utiliser. Lorsque vous soumettez votre demande, l'organisation est avertie, l'administrateur de l'API évalue votre demande et peut être amené à vous contacter pour plus détails. D'autres plans sont disponibles immédiatement.

Le nombre de requêtes, pour différentes API, que votre application a effectuées est affiché sur la page de votre application. Cliquez

sur « Applications » dans le menu principal, puis cliquez sur votre application. Dans le tableau « Abonnements aux produits », vous verrez tous les forfaits auxquels votre application est abonnée.

Pour chaque API contenue dans ce forfait, vous pouvez voir l'utilisation par rapport à la limite de débit du forfait.

Il est possible de tester une API à partir de ce portail développeur.

Lorsque vous consultez les détails d'une API, vous verrez une liste des opérations contenues dans l'API. Cela affichera le verbe et le chemin à utiliser pour l'opération.

Si vous cliquez sur l'opération, vous verrez plus d'informations à son sujet, les paramètres qu'elle peut prendre, ce qu'elle renvoie, les codes de retour possibles qu'elle peut utiliser et leur signification.

Il existe également un bouton « Essayer » sur les API REST qui vous permet d'essayer l'opération directement depuis le portail des développeurs.

Si l'API nécessite un identifiant client ou une clé secrète client pour l'identification, vous pouvez les spécifier à l'aide des informations d'identification de votre application en haut de la section « Essayer ».

Lorsque vous ajoutez une application, vous recevez une clé d'API et une valeur confidentielle d'API pour l'application. Vous devez fournir ces informations d'identification lorsque vous appelez une API qui vous demande d'authentifier votre application.

Pour enregistrer une application, cliquez sur Applications dans le menu principal, puis sur le lien « Créer une nouvelle application ». Une fois que vous aurez fourni le nom et la description de votre application, etc., vous verrez s'afficher la clé API et le secret de votre application.

Notez bien votre secret API, car il ne s'affiche qu'une seule fois.

Votre clé secrète API est stockée sous forme cryptée, nous ne pouvons donc pas récupérer la version non cryptée pour vous communiquer la valeur si vous l'oubliez.

Vous pouvez la réinitialiser, ce qui mettra à jour la valeur stockée et vous renverra la nouvelle valeur.

Pour ce faire, cliquez sur « Applications » dans le menu principal, cliquez sur l'application en question, puis cliquez sur le lien « Réinitialiser » dans la section « Clé secrète API ».

Votre nouvelle clé secrète s'affichera en haut de la page.