Utilisation de l'API

Aperçu

Coupa fournit un accès riche et robuste pour lire, modifier ou intégrer vos données via l'API RESTful. Cette interface basée sur XML UTF-8 vous permet de créer, de mettre à jour et d'agir sur des enregistrements individuels au sein de Coupa en effectuant un appel de demande HTTPS.

Nouveautés de Coupa Version 15

Les clés API peuvent être configurées pour fournir une autorisation d'accès et de gestion API. Cela donne aux administrateurs la possibilité de restreindre l'accès et l'utilisation de toutes les API Coupa à partir d'une seule clé API. Les clés peuvent également avoir une date d'expiration. Si un administrateur ne spécifie pas de date d'expiration, la clé n'expire jamais. Si une date d'expiration est spécifiée, la clé API expire à la fin de la journée (minuit UTC).

Comment utiliser l'API REST COUPA

Dans Coupa, toutes les données sont stockées en tant qu'objet métier ou ressource, et chaque ressource a une URL de ressource, tout comme une page Web. Chaque client Coupa a sa propre URL, de la forme {customer_name}.coupahost.com. Chaque ressource est sous la forme/api/[ressource]. Assurez-vous d'accéder à l'URL en utilisant https et non http lors de l'utilisation de l'API Coupa.

Par exemple, une URL d'API de facture ressemble à :

https ://{nom de l'instance}.coupahost.com/api/invoices

Veuillez noter que pour passer les appels de l'API Coupa, le programme appelant aurait besoin d'une clé API sécurisée. Contactez votre administrateur Coupa ou votre architecte d'intégration pour générer et vous fournir la clé. Gardez les clés API sécurisées et ne les partagez pas avec des utilisateurs non autorisés.

Toutes les demandes d'API doivent passer les en-têtes suivants :

• X-COUPA-API-KEY avec une clé Coupa API
• ACCEPTEZ l'en-tête avec la valeur définie sur application/xml.

L'API Coupa permet d'utiliser certains opérateurs et arguments, comme GET Supplier en fonction du nom (préfixe, suffixe, etc.) ou de la date de création, etc. Voir Premiers pas avec les API pour plus d'informations

Meilleure pratique

Les formats API peu profonds peuvent être utilisés sur les appels API pour limiter la charge utile des réponses API. L'API de Coupa renvoie beaucoup de données par défaut (par exemple : objets complets pour les associations). Il en résulte des valeurs de rendement qui peuvent être énormes et ces rendements peuvent 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é une commande return_object=limited qui renvoie une réponse xml limitée au lieu de l'ensemble du schéma d'un objet.

Traitement des erreurs/ messages

Pour cXML, les requêtes réussies renverront HTTP 200 OK. Le corps de la réponse inclura les détails de l'objet. Les demandes infructueuses retourneront une mauvaise demande HTTP série  4xx ou 5xx. Le corps de la réponse comprendra des erreurs de validation formatées en XML. Le programme d'appel doit avoir une logique de gestion des erreurs pour lire les messages de réponse et prendre des mesures correctives en conséquence.

Lorsque Coupa reçoit votre fichier de facture cXML, les étapes de validation suivantes ont lieu avant que la facture ne soit téléchargée dans Coupa.