Exemple C : créer un connecteur à partir d'une spécification d'API avec l'authentification par informations d'identification du client OAuth 2.0

Dans l'exemple suivant, nous construisons un connecteur pour USPS à partir de la documentation de l'API existante, en utilisant l'authentification par informations d'identification du client OAuth 2.0.

Importer à partir d'une documentation d'API

Avec cette approche, vous pouvez facilement importer autant de ressources que celles incluses dans la référence de l'API. Connector Builder vous permet de télécharger une documentation API existante au format JSON ou YAML, ou via Swagger ou Postman.

Dans l'exemple suivant, nous construisons un connecteur pour l'API de validation/de normalisation d'adresse USPS. Contrairement aux exemples A et B, nous :

• Téléchargez la référence de l'API sur le site Web USPS.
• Utilisez l'authentification par informations d'identification du client OAuth 2.0.

Télécharger la référence de l'API

1. Inscrivez-vous sur le portail des développeurs USPS (https://developer.usps.com/) et accédez au catalogue d'API.
2. Téléchargez la référence d'API pour laquelle vous souhaitez créer le connecteur. Par exemple : pour les adresses 3.0.

Importer la référence d'API dans le générateur de connecteurs (Connector Builder)

1. Téléchargez la référence d'API dans le générateur de connecteurs.

   

2. Après avoir sélectionné Créer, vous pouvez voir toutes les ressources disponibles dans la définition que vous avez téléchargée : GET/adresses, GET/état de la ville, GET/zipcode.

   

Configurer l'authentification

Ensuite, vous devez configurer l’authentification. Pour utiliser les informations d’identification du client OAuth 2.0, vous devez créer une application OAuth 2.0 dans le portail des développeurs USPS. Pour de plus amples informations, consultez le guide Premiers pas .

1. Dans le portail des développeurs USPS, accédez à Applications et sélectionnez Ajouter une application.

2. Configurez l'application. Une fois que vous l'avez créé, copiez les informations d'identification Clé du consommateur et Clé du consommateur . Ils correspondent aux champs ID client et Clé secrète du client.

   

3. De retour dans Générateur de connecteurs, définissez le type d’ authentification sur Informations d’identification du client OAuth 2.0.

4. Configurez les informations d’identification suivantes :

   1. ID client: <your Consumer Key>
   2. Clé secrète du client: <your Consumer Secret>
   3. Étendue: adresses
   4. URL du jeton: https://api.usps.com/oauth2/v3/token

5. Testez votre connecteur. Sélectionnez Envoyer une demande pour tester les ressources d’API créées et fournir les paramètres d’entrée comme suit :