Présentation de CCW API

Grâce à l'API REST de CCW, les clients et les partenaires peuvent créer de nouvelles applications et les intégrer à CCW de nouvelles façons, afin d'améliorer leurs capacités de gestion de la main-d'oeuvre temporaire. Les API CCW sont des API RESTful basées sur HTTP qui utilisent OAuth 2.0 pour l'authentification et TLS 1.2 pour la sécurité de la couche de transport. Cette documentation explique comment accéder à l'API de CCW et faire des demandes pour obtenir les données dont vous avez besoin.

Authentification

Les clients qui souhaitent accéder à l'API CCW REST peuvent enregistrer leur application B2C API et recevoir les identifiants du client OAuth 2.0 à utiliser en combinaison avec deux niveaux de sécurité supplémentaires (périmètres et droits d'accès utilisateur/rôle) pour authentifier les demandes à l'API CCW.

Jeton d’accès

La première étape pour accéder à l'API CCW consiste à demander un jeton d'accès en appelant avec les identifiants et le(s) périmètre(s) OAuth, comme dans l'exemple suivant :

curl -XPOST -H "Content-type: application/json" -d '{"client_id": "<<clientID>>", "client_secret": "<<secret>>", 
"scope":"ccw.candidate", "grant_type":"client_credential"}' 'Auth_Url'

Pour 'Auth_Url', utilisez ce qui suit, en fonction de votre environnement :

• Sandbox : https://sso-stg1.coupahost. com/as/token.oauth2
• Production : https://sso-prd1.coupahost. com/as/token.oauth2

Le serveur d’autorisation renvoie une charge utile JSON contenant les éléments suivants :

Points de terminaison API

Inclure le jeton d'accès reçu dans les appels aux points de terminaison API CCW. La demande est validée (ou renvoie une erreur - voir Codes d'erreur ).

Format du point de destination : https://<instance>/api/<resource path>

Exemples :

• Confirmation du candidat : https://{hostname}/API/candidats/{id}/confirmer
• Recherche de candidat : https://{hostname}/API/candidats/search
• Recherche de travailleur temporaire (CW) : https://{hostname}/API/travailleurs_temporaires

Demander des en-têtes

Les en-têtes de demande HTTP suivants sont requis :

Réponses d'erreur

Exemple de réponse erronée

{
 "error_code": "string",
 "error_summary": "string", 
 "error_causes": [
  {
   "error_sub_code": "string",
   "error_sub_code_desc": "string"
  }
 ]
}

Codes d'erreur

Reportez-vous aux sections Codes d'erreur de chaque API CCW spécifique :

• API de recherche du candidat - Codes d'erreur
• API de confirmation du candidat - Codes d'erreur
• API de recherche CW - Codes d'erreur

Limitation du taux

Les API REST CCW ne disposent pas de limite de débit explicite, mais la limitation des demandes API est recommandée pour une réponse rapide. Bientôt, les points de terminaison API individuels seront mis à jour avec la limitation de débit recommandée.

Meilleures pratiques

Voici quelques conseils pour garantir les meilleurs résultats lors de la création d'applications sur CCW à l'aide de nos API REST :

1. Éviter la validation du schéma : Les API CCW sont en constante évolution, avec de nouvelles propriétés facultatives ajoutées à l'API. À des fins d'extensibilité, les applications ne doivent pas effectuer de validation de schéma, ce qui peut déclencher des erreurs lorsque l'API envoie de nouvelles propriétés qui ne sont pas requises.
2. Utiliser les codes de statut HTTP : Les applications B2C doivent s'appuyer sur des codes d'état HTTP pour gérer les erreurs d'API, plutôt que sur le contenu du corps de la réponse, qui sert uniquement à des fins de diagnostic et de journalisation.
3. Éviter de dépendre de l'ordre des propriétés dans la réponse API : Les API CCW prennent uniquement en charge le contenu JSON. L'ordre des propriétés dans une réponse API peut changer en raison de l'introduction de nouvelles propriétés.