API Explorer

REST API Explorer de CCW est un outil interactif qui permet aux utilisateurs de tester et d'explorer l'API CCW de différentes manières :

• Parcourez les ressources et les points de destination REST API 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
• Effectuez des appels API authentifiés et autorisés via un framework intuitif qui ne nécessite pas de connaissances techniques

Pour utiliser l'explorateur d'API, l'accès à l'API REST de CCW doit d'abord être demandé au support CCW. Veuillez examiner le Présentation de CCW API pour en savoir plus sur l'accès et l'utilisation de l'API.

Accès à l'explorateur

Pour commencer, accédez à : Kit d’intégration > Documentation d’intégration , Cliquez. REST API Explorer.

Les API actuellement disponibles sont affichées :

• Recherche de candidat (/api/candidats/search)
• Confirmation du candidat (/api/candidats/{id}/confirmer)
• Recherche de travailleur temporaire (/api/contingent_workers)

Le URL de base , utilisé pour soumettre des demandes API, représente votre environnement de test CCW actuel.

À mesure que CCW ajoute de nouvelles API, Filtrer par marqueur 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 à tester et un formulaire est développé pour afficher Noms et Descriptions des paramètres disponibles :

Certains paramètres incluent un Exemple de valeur (affiché par défaut) et Modèle (cliquez pour voir les propriétés de chaque champ).

Le Réponses inclut les numéros de code (avec les descriptions) qui pourraient être inclus dans les réponses API de CCW.

Cliquez. Essayez-le pour modifier manuellement un exemple de demande dans le formulaire Explorer.

Pour le formatage approprié et d'autres exigences des demandes d'API CCW, veuillez examiner la documentation de chaque API spécifique :

• API de recherche candidate
• API de confirmation du candidat
• API de recherche de travailleur temporaire

ID de corrélation X, un champ obligatoire, généré automatiquement lorsque Essayez-le est cliqué.

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.

Cliquez. 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 annuler vos modifications.

Après exécution, le 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 API. Veuillez consulter la documentation liée ci-dessus pour plus de détails.