Utilisez l'application Postman pour créer des API REST standard pour les connecteurs personnalisés. Ce contenu offre un workflow général pour la création et l'exportation de collections Postman en tant que fichiers JSON.
La version gratuite de l'application dispose des fonctionnalités permettant de créer des collections avec des demandes et de les exporter pour les automatisations.
Cette rubrique fournit un aperçu général de ce que vous devez faire pour créer et exporter une collection. Elle doit servir de référence. Consultez le
Centre d'apprentissage Postman pour obtenir les dernières instructions sur la configuration du produit Postman.
Obtenez l'application Postman depuis l'adresse https://www.getpostman.com.
Procédure
- Ajoutez une collection.
- Ajoutez et configurez les demandes dans la collection.
- Le nom et la description fournis dans ces demandes sont utilisés dans les actions de workflow dans Workspace ONE Intelligence. Vous pouvez les modifier ultérieurement dans Workspace ONE Intelligence.
Voici un exemple d'entrée dans une demande Postman et son interprétation comme action dans les automatisations dans Workspace ONE Intelligence.
- Pensez à ajouter des en-têtes tels que Content-Type: application/json.
Si vous n'ajoutez pas d'en-têtes pour spécifier le type de contenu JSON, les API utiliseront éventuellement le format XML par défaut, et XML ne fonctionne pas avec les connecteurs personnalisés.
- Ajoutez les en-têtes personnalisés requis par votre API à toutes les demandes de la collection Postman. Des en-têtes personnalisés sont par exemple des types d'authentification uniques basés sur l'en-tête, tels qu'une clé API ou un jeton. Workspace ONE Intelligence conserve tous les en-têtes à l'exception des en-têtes d'authentification. Il remplace les en-têtes d'authentification par vos configurations pour Type d'authentification dans la collection personnalisée. Si Workspace ONE Intelligence remplace l'en-tête d'authentification, le système envoie tout de même votre authentification unique basée sur l'en-tête pour utilisation car vous l'avez ajoutée à d'autres demandes.
- Envoyez la demande pour la valider.
La validation génère la réponse.
- Enregistrez la réponse comme exemple pour la documentation.
Le protocole Open API exige cette étape.
- Enregistrez la demande.
- Ajoutez d'autres demandes si nécessaire.
- Exportez la collection en tant que Collection v2.1.
Que faire ensuite
Ajoutez la collection JSON à Workspace ONE Intelligence. Pour plus d'informations, accédez à Enregistrer un connecteur personnalisé.