Authentification

Toutes les données sont stockées en tant qu'objet métier ouressource,et chaque ressource possède uneURLde ressource , tout comme une page Web, où chaque ressource se trouve dans le formulaire./api/{resource_name}. Assurez-vous d'accéder à l'URL à l'aide d'https://plutôt que http:// lorsque vous utilisez l'API Coupa. Chaque client Coupa possède sa propre URL, au format {instance_name}.coupahost.com. Par exemple : https://companyname.coupahost.com/api/users.

Coupa recommande d' authentifier les demandes API en utilisant OpenID Connect.

Historiquement, avant la prise en charge d'OpenID Connect, les demandes d'API étaient authentifiées par unecléAPI unique, générée dans Coupa. Cette méthode est toujours supportée, mais elle sera complètement obsolète dans R35. Toutes les demandes API utilisant cette méthode d'authentification doivent passer un en-tête X-COUPA-API-KEY», une clé API et l' ACCEPTen-tête avec la valeur définie sur application/xmlpour les réponses XML ou application/json pour les réponses JSON.  Un utilisateur admin peut créer une clé à partir de la section Clés APIde l'onglet Configuration. La clé est un code alphanumérique sensible à la casse de 40 caractères. Elle est associée à un utilisateur API équivalent à un utilisateur administrateur sur Coupa. Toute modification des ressources via l'API sera attribuée à l'utilisateur de l'API.

La sécurité de la clé API peut être configurée, par exemple, en définissant des dates d'expiration, en révoquant une clé et en configurant les objets et les méthodes auxquels une clé a accès.

Quelles méthodes sont supportées par l'API ?

GET (Read Data)- Une demande HTTP GET interrogera Coupa et renverra des informations au format JSON ou XML.  Une demande à la racine de la ressource répertorie les 50 premiers objets à partir de l'ID 1. Utilisez ces argumentspour affiner la requête.

PUT (Mettre à jour les données)- Une demande HTTP PUT pour/api/{resource}/{id}tenter de mettre à jour une ressource. Une seule ressource peut être mise à jour par demande et la charge utile doit être un document JSON ou XML avec les éléments à mettre à jour. Tous les champs ne sont pas disponibles via l'API et toutes les données référencées doivent déjà exister ou la valeur ne sera pas modifiée.

POST (Create Data)- Une demande HTTP POST à la racine de la ressource avec une charge utile JSON ou XML tentera de créer une nouvelle ressource. En cas de réussite, la ressource est renvoyée avec le nouvel ID, qui est généré par Coupa.

Quand dois-je utiliser l'API ?

L'API Coupa vous permet de créer, de mettre à jour et d'interroger des entrées individuelles. Elle sera principalement utilisée pour gérer des objets dans Coupa. Avec des actions RESTful standard et des entrées et sorties définitives, il est l'option facile au jour le jour pour les actions non massives. Ces méthodes sont accessibles à tout moment et sont intégrées à des outils qui vous permettent de vérifier simplement si un appel sera traité avec succès ou de minimiser la sortie des réponses. Il est principalement utilisé pour effectuer des mises à jour individuelles simples ou pour interroger des données.

XML vs JSON

Coupa prend en charge XML et JSON.  Vous trouverez ci-dessous des informations de base sur chacun :

Le langage XML (Extensible Markup Language) est un ensemble de règles pour le codage de documents sous forme lisible par machine. Les objectifs de conception de XML mettent l’accent sur la simplicité, la généralité et la facilité d’utilisation sur Internet.

JavaScript Object Notation (JSON) est un standard ouvert léger basé sur du texte conçu pour l'échange de données lisibles par l'homme. Il est dérivé du langage de programmation JavaScript pour représenter des structures de données simples et des tableaux associatifs, appelés objets. Malgré sa relation avec JavaScript, il est indépendant du langage, avec des analyseurs disponibles pour la plupart des langages de programmation.

JSON est moins explicite que XML, car XML nécessite des balises d'ouverture et de fermeture (ou dans certains cas des balises à fermeture automatique moins détaillées), et JSON utilise des paires nom/valeur, délimitées de manière concise par "{" et "}" pour les objets, "[" et "]" pour les tableaux, "," pour séparer les paires et ":" pour séparer le nom de la valeur.

Différences entre XML et JSON dans Coupa

Exemples de demandes/réponses - XML vs JSON

Utilisation de GraphQL

GraphQL est une spécification ouverte pour un langage de requête API (donc la référence « QL ») qui vous permettra de rendre vos intégrations plus réactives que jamais en vous donnant la possibilité de demander les données dont vous avez besoin et rien de plus. GraphQL peut également réduire le nombre d'appels et d'allers-retours associés en récupérant toutes les ressources dont vous avez besoin en un seul ou plusieurs appels.

Voir Présentation de GraphQL pour plus d'informations.

Quand utiliser les fichiers plats SFTP ?

Les fichiers plats vous permettent de charger de nombreux enregistrements via une seule transaction. Une fois l'intégration configurée, elle s'exécutera automatiquement en fonction des paramètres définis. Les exécutions d'intégration et les erreurs sont gérées dans l'application et fournissent des informations sur le nombre d'entrées ajoutées, les détails de l'erreur et les personnes automatiquement contactées à propos de l'erreur. Il est principalement utilisé pour effectuer des mises à jour ou des ajouts en masse sur les composants clés du produit, tels que les utilisateurs ou les fournisseurs.

Informations supplémentaires

wiki.tree(page.path)