Intégration de l'API REST COUPA

Introduction

Les demandes d'authentification d'API nécessitent une clé API unique, générée dans Coupa.

Toutes les requêtes API doivent passer un en-tête X-COUPA-API-KEY avec une clé API.  Une clé peut être créée à partir de la section Clés d'API de l'onglet Administration par un utilisateur administrateur. La clé est un code alphanumérique sensible à la casse de 40 caractères. La clé API est associée à un utilisateur API qui est l'équivalent d'un utilisateur administrateur dans Coupa. Toute modification des ressources via l'API est attribuée à l'utilisateur de l'API.

Outre la clé, toutes les requêtes API doivent également passer l'en-tête ACCEPT avec une valeur définie sur application/xml.

À l'aide de l'API Coupa, vous pouvez exécuter des requêtes avancées pour identifier et extraire rapidement les données dont vous avez besoin.

Voir Options de requête pour plus d'informations.

L'API Coupa permet d'utiliser certains opérateurs et arguments, par exemple, OBTENIR le fournisseur en fonction du nom (préfixe, suffixe, etc.) ou de la date de création.

Voir Opérateurs d'API et arguments pour plus d'informations.

Bonnes pratiques

• Les formats API peu profonds peuvent être utilisés sur les appels API pour limiter la charge utile de la réponse API. L'API Coupa renvoie beaucoup de données, par défaut, par exemple, des objets complets pour les associations. Il en résulte des valeurs de retour qui peuvent être énormes et donc entraîner une dégradation des performances. Cela peut être un problème pour les clients qui n'ont pas besoin des données superflues ; sans parler de la consommation inutile de ressources. Pour mieux répondre aux besoins de nos clients, Coupa a ajouté la commande return_object=limited qui renvoie une réponse XML limitée au lieu de l'ensemble du schéma d'un objet.
• Mettez à jour l'enregistrement de l'historique d'intégration et les objets Integration Run pour chaque appel d'API (succès/échec), de sorte que toutes les transactions soient enregistrées et consultables dans les journaux Coupa.

Pour plus d'informations sur les enregistrements de l'historique de l'intégration et l'utilisation de l'exécution de l'intégration, consultez les rubriques suivantes :

• Surveillance de l'intégration des API
• API d'enregistrement de l'historique d'intégration
• API d'exécution d'intégration

Enfin, pour plus d'informations sur les intégrations d'API REST, voir L'API Coupa.