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' ACCEPT
en-tête avec la valeur définie sur application/xml
pour 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.
Obscurcissement des clés API
R32 - OAuth2.0 est la seule option disponible pour les nouveaux clients
R34 - les nouvelles clés API ne peuvent plus être émises pour les clients existants
R35 - Les clés API ne seront plus prises en charge
Plus de détails
Validez toujours la présence d'éléments dans le fichier XML/JSON avant de récupérer la valeur car la structure de la charge utile Coupa peut changer à l'avenir pour ne pas afficher certains champs qui n'ont pas de valeurs ou qui ont des valeurs nulles.
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.
La suppression de donnéesn'est prise en chargepour aucune ressource via l'API. Les utilisateurs peuvent désactiver un sous-ensemble de ressources en utilisant une demande PUT.
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
Quelle que soit la méthode choisie, l'API Coupa exige que vous définissiez vos en-têtes content-type et content-accept sur le même type. Ne pas mélanger et assortir.
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)
Coupa prend en charge un certain nombre d'opérateurs pour vous permettre d'effectuer des requêtes avec précision.
Utilisez le format d'API peu profond de Coupa pour réduire la quantité de données obtenues au cours d'une requête.
Sécurité améliorée de la clé API avec expiration de la clé API et autorisations spécifiées par l'administrateur pour les API.
Espace de noms de champ personnalisé
Tous les nouveaux champs personnalisés sont ajoutés à un espace de noms de champs personnalisés pour éviter les conflits de noms et rendre les champs ajoutés par les clients plus facilement identifiables.
En savoir plus sur les types d'arguments pris en charge par Coupa conjointement avec les opérateurs.
Découvrez comment utiliser les requêtes pour identifier et extraire rapidement les données dont vous avez besoin.
Actions spéciales et notes API
Informations supplémentaires sur l'utilisation de l'API Coupa.
Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.
- Table des matières
-
L'API Coupa Core
-
Ressources
-
Ressources de données de référence
- API de règles de validation de compte (/account_validation_rules)
- API des types de compte (/account_types)
- API Utilisateurs (/users)
- API des comptes (/comptes)
- Adresse API (/adresses)
- API des groupes de contenu (/business_groups)
- API Enregistrements fiscaux (/tax_registrations)
- API des annonces (/annonces)
- API des lignes budgétaires (/lignes budgétaires)
- Devises API (/devises)
- API d'entités commerciales (/business_entities)
-
API fournisseurs (/fournisseurs)
- API d'association pour la diversité
- API de catégorie et de sous-catégorie de diversité
- API d'agence de certification de diversité
- API du fournisseur mandataire
- API de site punchout
- API des articles du fournisseur (/supplier_items)
- Exemples d'appels d'articles du fournisseur
- API de paiement du fournisseur
- API Sites fournisseur (/supplier_sites)
- API utilisateur du fournisseur
- Exemples d'appels d'API de fournisseurs
- API du contact du support client
- API des modalités de paiement (/payment_terms)
- API Remit-To Addresses (/fournisseurs/adresses)
- API des conditions d'expédition (/shipping_terms)
- API Sources du fichier de données (/data_file_sources)
- API Départements (/départements)
- API des taux de change (/exchange_rates)
- API des contreparties financières (/financial_counterparties)
- API des articles (/items)
- API des documents juridiques (/legal_documents)
- API des valeurs de recherche (/lookup_values)
- API d'allocations correspondantes (/matching_allocations)
- API des projets (/projects)
- Fiche tarifaire API
- API d'informations sur le fournisseur (/supplier_information)
- API des sites d'informations sur les fournisseurs (/supplier_information_sites)
- API d'enregistrement fiscal des informations sur les fournisseurs (/supplier_information_tax_registrations)
- API de tâche (/tasks)
-
Ressources transactionnelles
- API Avis d'expédition avancée (/asn)
- Approbations API (/approbations)
-
API des dépenses (/expense_reports)
- Exemples d'appels pour l'API de dépenses
- API des objets des dépenses
- API des lignes de frais
- API des participants aux dépenses
- API de type de participant à la dépense
- API d'avance de fonds pour les dépenses
- API des notes de frais
- API de catégorie de notes de frais
- API de traduction de la catégorie de dépenses
- API d'allocation des lignes de frais
- API des participants à la ligne de notes de frais
- API d'avance de fonds de ligne de dépenses
- API de données importées de la ligne de dépenses
- API d'allocation de kilométrage de la ligne de dépenses
- API de kilométrage de la ligne de dépenses
- API per diem de la ligne de dépenses
- API d'imposition de la ligne de frais
- API de carte virtuelle Expense Line
- API d'approbation préalable de dépenses
- API de ligne d'approbation préalable de dépenses
- API de pré-approbation de note de frais
- API Frais de déplacement
- API de segment de voyage d'affaires
- API de violation des dépenses
- API de la carte virtuelle de dépenses
- API de la ligne de frais détaillés
- API de statut d'audit
- Entité juridique API
- API des frais (/frais)
- API des produits de base (/produits de base)
-
API des contrats (/contrats)
- API de classification du contrat
- API de la clause contractuelle
- API de référence de la clause contractuelle
- API des détails du contrat
- API du litige contractuel
- API du partenaire contractuel
- API du contact de la partie contractante
- API du modèle de contrat (/contracts/templates)
- API des types de contrats
- API des conditions du contrat
- API de subdivision de pays
- Propriété intellectuelle et API de données
- API Reason Insights
- API Reason Insights Events
- Exemple d'appels d'API de contrat
- API des relevés de coupon de paiement (/coupa_pay/statements)
- API Objet personnalisé (/custom_objects/id)
- API des lignes de comptage de cycles (/cycle_count_lines)
- API Sources du fichier de données (/data_file_sources)
- API d'emplacement de réception par défaut (/emplacement de réception par défaut)
- API Sites de réception par défaut (/default_receiving_locations)
-
API INVOICES (/INVOICES)
- Échecs de l'API Tolérances
- API de la ligne de la facture
- API de la facture entrante
- API d'affectation des frais de facturation
- API des frais de facturation
- Exemples d'appels de l'API Paiements de factures
- Exemples d'appels de l'API INVOICE
- API de la société immatriculée
- API de la ligne de taxe
- API de ligne de retenue à la source
- API Motif de la contestation
- API Easy Form Responses (/easy_form_responses)
- API des dettes (/payables/)
- API des intégrations (/integrations)
-
API des reçus
- API de consommation d'inventaire (/inventory_consumption)
- Exemples d'appels de l'API Reçus
- API de lot de mouvement de stock
- API des transferts d'inventaire (/inventory_transfers)
- API de réception des transactions (/receiving_transactions)
- API des demandes de retour (/return_requests)
- API Return to Supplier Transactions (/return_to_supplier_transactions)
- Code d'ajustement API
- API Ajustements de stocks (/inventory_adjustments)
- API Listes de sélection/Réservations d'exécution (/listes de sélection)
- API de traduction d'objet (/uoms/uom_id/translations)
-
API des bons de commande (/purchase_orders)
- API d'affectations de ligne de commande
- API de lignes de commande
- API de détail de taxe de modification de ligne de commande
- API de détail de l'impôt de la ligne de commande
- API de modification du bon de commande
- API de changement de ligne de bon de commande
- Exemples d'appels d'API de révisions de bons de commande
- Exemples d'appels API pour les bons de commande
- API de la ligne Montant de la commande
- API des demandes (/demandes)
- API de confirmation de commande (/order_header_confirmations)
- Liste des commandes API (/order_pads)
- API de paiement (/coupa_pay/payments )
- API d'approvisionnement (/quote_requests)
- API des demandes de réception (/receipt_requests)
- Services Procurement API (/services_procurement)
- API de flux Risk Aware fournisseur (/supplier_risk_aware_feed)
-
Ressources partagées
- Montant - API du composant
- API Étiquettes d'actif
- API de fichier en pièce jointe
- Pièces jointes API
- Commentaires API
- API de la période budgétaire
- Prix de vrac API
- Unité de mesure API
- API de lot de ligne de comptage de cycles
- API de compte de fournisseur de signature électronique
- ExtraLineAttributes : :API OrderLineAttribute
- API du formulaire
- API des achats groupés et des adhésions
- API des paiements
- Objets API
- API de demande de risque RA
- API de relation de demande de risque RA
- API de score de demande de risque RA
- API pour contrat pour RA CLMA
- API de ligne de demande de retour
- Planifier l'API de ligne
- API de modification de l'en-tête de la commande du fournisseur
- API de balise
- API de balisage
- API de catégorie de compte
- API du groupe de compte
- API alternative
-
Ressources de données de référence
- OAuth 2.0 et OIDC
-
Démarrez avec l'API
- Opérateurs de l'API
- Formats de retour de l'API
- Arguments
- Espace de noms de champ personnalisé
- Différences entre XML et JSON dans Coupa
- Traitement des exceptions et codes d'erreur
- Présentation de GraphQL
- Options de requête
- Exemples de demandes/réponses - XML vs JSON
- Actions spéciales et notes API
- Sécurité de la clé API
- Orchestration Documents
-
Ressources
- Formats de téléchargement API et CSV de base
-
Fichiers plats (CSV) Coupa Core
-
Importation de fichier plat (CSV)
- Importation de règles de validation de compte
- Importation d'adresses
- Importation de préavis d'expédition
- Importation de la chaîne d'approbation
- Importation du rajustement de la ligne budgétaire
- Importation de ligne de budget
- Importation d'entité commerciale
- Importation de marchandises
- Importation de la traduction de la catégorie d'achats
- Importation de groupe de contenu
- Importer le contrat
- Import Départements
- Importation de l'entreprise
- Importation du taux de change
- Importation de limite dynamique de catégorie d'action de dépense
- Importation de la catégorie de notes de frais
- Importation des taux d'imposition de la catégorie de dépenses
- Importation de la traduction de la catégorie de dépenses
- Importation du mappage de catégories de notes de frais
- Importation du mappage de filtres de type de transactions de dépenses
- Importation du mappage d'utilisateurs de notes de frais
- Importation de données de kilométrage de dépenses
- Importation du paiement des notes de frais
- Importation de commandes externes
- Paiements externes
- Importation des contacts d'intégration
- Importation d'intégration
- Importation de la balance de l'inventaire
- Importation de lot de la balance d'inventaire
- Importation de transactions d'inventaire (reçus)
- Importation de paiements de factures
- Importation de factures
- Importer un article
- Importation d'entité juridique
- Chargeur de reçus de paiement légal
- Importation des valeurs de référence
- Importation d'instance d'objet
- Importation de la traduction de l'objet
- Importation de la confirmation de la commande
- Payables : : Affectation
- Payables : : Externe : : Importation des frais à payer
- Importer le paiement
- Importation des modalités de paiement
- Importer un projet
- Modification d'un bon de commande - Importation
- Importation de la ligne de demande de devis
- Noter l'importation du fournisseur
- Importation des adresses de paiement
- Importation des demandes
- Importation de feuilles de service/temps
- Expédiable Tracker Import
- Importation de flux de sensibilisation aux risques fournisseurs
- Site du fournisseur - Importation
- Importation de fournisseurs
- Importation du code d'imposition
- Importation de règle de code d'imposition
- Importation du taux d'imposition
- Importation de la référence de la
- Importation de l'immatriculation fiscale
- Importation de flux de trésorerie de trésorerie
- Importation des taux des matières premières du Trésor
- Importation de spreads de crédit de trésorerie
- Importation des taux de change à terme du Trésor
- Importation des taux d'intérêt du Trésor
- Volatilities des intérêts de trésorerie Importation
- Importation des soldes des fonds monétaires de la trésorerie
- Importation de groupes d'utilisateurs
- Importer des utilisateurs
- Importation d'entrepôt
- Importation de l'emplacement de l'entrepôt
- Importer le compte
- Importation de type de compte (COA)
- Formulaires (Formulaires simplifiés) Importation
-
Exportation de fichier plat (CSV)
-
Standard CSV Exports
- Exportation de marchandises
- Exportation de contrats
- Exportation des frais Coupa Pay
- Exportation de paiements Coupa Pay
- Exportation des relevés Coupa Pay
- Exportation de la source du fichier de données
- Exporter les délégations
- Exportation de réponse au widget Formulaire simplifié
- Exportation du taux de change
- Exportation de pré-approbation de frais
- Exportation des notes de frais
- Erreur d'intégration lors de l'exportation
- Exportation d'enregistrement d'historique d'intégration
- Exportation du solde de l'inventaire
- Exportation des transactions d'inventaire (reçus)
- Exportation de factures
- Exporter l'article
- Valeurs de référence à exporter
- Exportation de la traduction de l'objet
- Exportation de la modification de l'en-tête de la
- Exportation de la confirmation de l'en-tête de commande
- Exportation d'allocation de changement de ligne de commande
- Exportation de la modification de la ligne de
- Exportation de la confirmation de la ligne de commande
- Payables : : Affectation
- Payables : : Dépense
- Payables : : Exportation de pré-approbation de frais
- Exportation de factures à payer
- Exportation du jalon de l'approvisionnement
- Exportation de projet
- Exportation du lien du projet
- Exportation des bons de commande
- Exportation des remises aux adresses
- Exportation de demandes
- Planifier l'exportation de ligne
- Exportation d'approvisionnement
- Exportation de la demande de devis de sourcing
- Exportation de réponses au devis de sourcing
- Rapport sur la diversité des fournisseurs - Exportation des dépenses directes
- Rapport sur la diversité des fournisseurs - Exportation des dépenses indirectes
- Résumés du rapport sur l'inclusivité des fournisseurs
- Exportation des informations fournisseur
- Site de renseignements sur les fournisseurs
- Site fournisseur
- Exportation du code des taxes
- Exportation de règle de code d'imposition
- Exportation de l'immatriculation fiscale
- Exportation de ligne fiscale TCS
- Exportation du groupe d'utilisateurs
- Exportation de confirmation/en-tête de travail (en-tête de feuille de temps/service)
- Confirmation de travail/Ligne (Ligne de la feuille de service/feuille de temps) Exportation
- Exportation de type de compte
- Exportation d'avis d'expédition avancée
-
Standard CSV Exports
- Les premiers pas
-
Importation de fichier plat (CSV)
-
Treasury Integrations
-
Descriptions du format CSV de la trésorerie (classique)
- Format du fichier d'exportation du tableau CSV
- Format CSV d'importation pour les jours fériés
- Balances IC - Importation des taux de change - Format CSV
- Filet IC - Importation des taux de change - Format CSV
- Compensation IC - Exportation de paiements - Format CSV
- IC Recon - Exportation de facture - Format CSV
- Formats CSV d'importation de serveur IC Recon
- LMPLANNING - Importation de données de planification de liquidité
- Système - Importation de scénarios de change et de taux d'intérêt
- Système - Importation de données de marché
- Importation du plan d'intérêts et de remboursement du contrat TTC
- Importation du plan de paiement de location TTContract
- Format CSV d'exportation des réservations TTGL
- Importation de relevé de compte - Format CSV
- Formats CSV d'importation de données de flux de trésorerie
- Exportation de flux de trésorerie - Format CSV
- Afficher la documentation de l'API de trésorerie
-
Descriptions du format CSV de la trésorerie (classique)
- Coupa Core User Authentication (SSO)
- CCW Flat Files (CSV)
- The CCW API
- Adresses IP des applications Coupa Core
- S'appuyer sur la plateforme Coupa
- Risk Assess Quick Integration
- The CSO API