Explorateur API
L'Explorateur d'API REST de CCW est un outil interactif qui permet aux utilisateurs de tester et d'explorer les API CCW.
L'Explorateur d'API REST de CCW est un outil interactif qui permet aux utilisateurs de tester et d'explorer l'API CCW des manières suivantes :
- Parcourir les ressources et LES points de terminaison de l'API REST disponibles
- Découvrez les méthodes disponibles pour chaque API, ainsi que les paramètres pris en charge et la documentation en ligne
- Expérimentez en soumettant des exemples de demandes pour tout point de terminaison API disponible et consultez les réponses en temps réel
- Effectuer des appels API authentifiés et autorisés via un cadre intuitif qui ne nécessite aucune formation technique
Pour utiliser l'explorateur d'API, l'accès à l'API REST de CCW doit d'abord être demandé au support CCW. Veuillez consulter la documentation de présentation de l'API CCW pour en savoir plus sur la façon d'accéder et d'utiliser l'API.
Accès à l'Explorateur
Pour commencer, accédez à : Documentation d'intégration de la boîte à outils > d'intégration . Cliquez sur Explorateur API REST.
Un accès spécifique à l'Explorateur peut être accordé à tout utilisateur et/ou rôle de la CCW en attribuant la documentation d'intégration de la boîte à outils > d'intégration appropriée.
Les API actuellement disponibles sont affichées :
- Recherche de candidats (/api/candidates/search)
- Confirmation du candidat (/api/candidates/{id}/confirm)
- Recherche de travailleurs occasionnels (/api/contingent_workers)
L'URL de base, utilisée pour soumettre des demandes d'API, représente votre environnement de test CCW actuel.
Comme CCW ajoute plus d'API, la barre Filtrer par balise vous permettra de trouver une API spécifique en entrant des mots clés qui correspondent aux en-têtes de section.
Test des API
Cliquez sur l'API que vous souhaitez tester, et un formulaire est développé montrant les noms et les descriptions des paramètres disponibles :
Certains paramètres incluent une valeur d'exemple (affichée par défaut) et un modèle (cliquez pour voir les propriétés de chaque champ répertorié).
La section Réponses comprend des numéros de code (avec des descriptions) qui pourraient être inclus dans les réponses API de CCW.
Cliquez sur Essayer pour modifier manuellement un exemple de demande dans le formulaire Explorateur.
Pour le formatage approprié et d'autres exigences des demandes d'API CCW, veuillez consulter la documentation de chaque API spécifique :
- API de recherche de candidat
- API de confirmation du candidat
- API de recherche de travailleur temporaire
L'ID de corrélation X, un champ obligatoire, se génère automatiquement lorsque vous cliquez sur Essayer .
L'autorisation, également obligatoire, nécessite un jeton d'accès qui doit être généré en dehors de l'Explorateur. Une fois généré, le jeton d'accès dure 1 heure.
Une application telle que Postman peut être utilisée pour générer le jeton d'accès et le copier dans le champ Autorisation. Dans Postman, entrez les informations d'identification d'accès à l'API fournies par Coupa, y compris l'URL du jeton d'accès, le secret et la portée.
Cliquez sur Exécuter pour soumettre votre demande à l'URL de base avec les paramètres supplémentaires que vous avez saisis. Ou cliquez sur Annuler pour ignorer vos modifications.
Après l'exécution, la section Réponse comprend le corps de la réponse, les en-têtes (et les erreurs, le cas échéant) envoyés en réponse à votre demande d'API. Veuillez consulter la documentation liée ci-dessus pour en savoir plus.