Foire aux questions

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 indiquent le nombre de demandes qu'une application est autorisée à émettre pendant un intervalle donné.

Utilisez ce portail de développeur pour consulter les différents plans disponibles et sélectionnez le plan le mieux adapté à vos exigences. 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 demandes, pour différentes API, effectuées par votre application s'affichent sur la page de votre application.

Cliquez sur 'Applications' dans le menu principal, puis sur votre application. Tous les plans auxquels votre application est abonnée s'affichent dans la table 'Abonnements de produit'.

Pour chaque API contenue dans ce plan, vous pouvez voir l'utilisation comparée à la limite de débit du plan.

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

Lorsque vous consultez les détails d'une API, la table des opérations contenues dans l'API s'affiche. Celle-ci indique l'instruction et le chemin à utiliser pour l'opération.

Si vous cliquez sur cette dernière, les informations la concernant s'affichent, ainsi que les paramètres utilisés, ce qu'elle renvoie, ainsi que les codes retour qu'elle peut utiliser et ce qu'ils signifient.

Il existe également un bouton 'Essayer' dans les API REST qui permet d'essayer la ressource directement à partir du portail de développeur.

Si l'API requiert un ID client ou une valeur confidentielle du client à des fins d'identification, vous pouvez spécifier vos données d'identification d'application dans la partie supérieure 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 données 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 application'. Après avoir indiqué le nom et la description de l'application, la clé d'API et la valeur confidentielle d'API correspondantes s'affichent.

Prenez note de la valeur confidentielle d'API, car elle ne s'affiche qu'une seule fois.

La valeur confidentielle d'API est stockée sous forme chiffrée afin que nous puissions extraire la version non chiffrée pour vous indiquer la valeur si vous l'avez oubliée.

Vous pouvez la redéfinir, ce qui met à jour la valeur stockée et vous renvoie la nouvelle valeur.

Pour cela, cliquez sur 'Applications' dans le menu principal, puis sur l'application concernée et enfin sur le lien 'Réinitialiser' dans la section 'Valeur confidentielle d'API'.

La nouvelle valeur confidentielle s'affiche en haut de la page.