Intégration des BC et des modifications de BC dans votre ERP
Instructions détaillées pour intégrer vos bons de commande Coupa et les modifications de vos bons de commande à votre ERP.
Introduction
Vous pouvez également télécharger ce document en tant que document Microsoft Word :Coupa Purchase Orders sur ERP.docx
Considérations générales sur la configuration API
- Prise en main de l'API Coupa
- Sécurité de la clé API (sera éventuellement obsolète)
- AccèsAPI Open Connect (à partir de R29)
- JSON/XML
- GraphQL (à partir de R30)
Charge utile limitée - champs et filtres API
L'API de Coupa renvoie beaucoup de données par défaut (par exemple : des objets complets pour les objets associés). Les charges utiles de retour API peuvent être très importantes et donc lentes. Cela peut poser problème aux clients qui n'ont pas besoin de données superflues, sans parler de la consommation inutile de ressources.
Pour faciliter les choses, Coupa utilise le concept de paramètres « fields » et de filtres API qui renvoient une réponse JSON ou XML limitée au lieu du schéma entier, et de toutes les associations, pour un objet.
- Filtres de réponse API
- API : Using the new API query parameter "fields", Alternative to "return object"
Cas d'utilisation décrits dans cet article
Dans ce document, nous partons du principe que le numéro de bon de commande dans l'ERP est déterminé par le numéro de bon de commande Coupa. Cet article décrit les 3 différentes options d'intégration des bons de commande Coupa dans votre ERP (pour la création et les mises à jour).
Ces options modifieront la façon dont vous pouvez surveiller vos intégrations à partir de Coupa :
- Option 1: Surveillance simple basée sur le ou les champs personnalisés que vous définissez dans l'en-tête de la commande
- Option 2: Surveillance avancée à l'aide des historiques d'intégration
- Option 3: bénéficier d’une surveillance complète de l’intégration Coupa
Pour les 3 options, les bons de commande Coupa sont transmis à l'ERP en fonction de l'indicateur d'exportation.
En cas d'erreur, lors de l'intégration d'un bon de commande, une modification manuelle sera requise sur le bon de commande dans l'interface utilisateur Coupa : cette modification réinitialisera l'indicateur d'exportation et le bon de commande sera donc pris en compte lors de la prochaine exécution
Coupa vous suggère de contacter l'assistance Coupa pour lui demander d'activer cette option : Réinitialisezle dernier BC exporté à chaque modification. Ce paramètre s'applique uniquement à l'interface utilisateur. Les modifications apportées à l'API ne modifieront pas le statut Exporté.
Créer une intégration et un contact dédiés pour l'API
Pour les options 2 et 3, vous devez créer :
- Une intégration dédiée pour chaque orchestration API que vous mettez en oeuvre
- Un ou plusieurs contacts d'intégration pour chaque intégration, qui seront alertés en cas d'échec d'intégration
Coupa suggère de contacter l'assistance Coupa pour lui demander d'activer cette option : Activer le lien vers l'historiquede l'intégration par typede document . Ce paramètre ajoute un lien dans la page de configuration pour afficher l'historique d'intégration complet par type de document
Option 1 : Surveillance simple basée sur des champs personnalisés
Description
Dans ce scénario, pour chaque bon de commande, nous ajouterons l'état d'intégration actuel dans un ou plusieurs champs personnalisés d'en-tête de bon de commande. Nous avons ajouté un champ personnalisé cf-integration-status
avec le nomIntegration Status
. Utilisez la table de données des bons de commande standard pour suivre l'état d'intégration de vos documents à l'adresse suivante :https://<your instance hostname>/order_headers
.
Diagramme d'orchestration
Détails des étapes/appels API
Étape 1 |
Obtenez la liste et les détails des bons de commande Coupa à créer/mettre à jour dans l'ERP. |
---|---|
Méthode |
OBTENIR |
API |
|
Paramètres de requête |
|
URL exemple |
https :// |
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
* = show_removed_lines=vrai pour les modifications de BC
Étape 2 |
Marquer chaque BC comme exporté |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O * |
Corps de réponse échantillon |
|
* Pour cet appel, vous n'avez pas besoin d'une charge utile si vous incluez « ?exported=true» dans l'URL. C'est là que se produit la création/mise à jour du bon de commande dans l'ERP.
Étape 3 |
Mettre à jour un champ personnalisé pour le rapport |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
ou
|
Corps de réponse échantillon |
ou
|
Option 2 : Surveillance avancée à l'aide de l'historique d'intégration
Description
Dans ce scénario, pour chaque bon de commande, nous :
- Résoudre l'enregistrement d'historique d'intégration précédent pour le document
- Créer un historique d'intégration
- Créer une alerte pour le contact d'intégration en cas d'erreur
Chaque document inclut les détails de l'historique d'intégration :
Utilisez la table de données de l'historique d'intégration des bons de commande standard pour suivre le statut d'intégration de vos documents. Vous pouvez le trouver sur :https://<your instance hostname>/integration_history_records/purchase_orders
.
Vous pouvez utiliser un filtre sur le code de réponse pour différencier les documents répliqués avec succès des documents qui ont échoué.
Diagramme d'orchestration
Détails des étapes/appels API
Étape 1 |
Obtenez la liste et les détails des bons de commande Coupa à créer/mettre à jour dans l'ERP. |
---|---|
Méthode |
OBTENIR |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
Étape 2 |
Marquer chaque BC comme exporté |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
C'est ici que se produit la création/mise à jour du bon de commande dans l'ERP.
Étape 3a |
Obtenir un historique d'intégration non résolu |
---|---|
Méthode |
OBTENIR |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Étape 3b |
Résoudre l'historique d'intégration précédent |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Étape 4a |
Créer un historique d'intégration (réussite) |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
|
Corps de réponse échantillon |
|
Étape 4b |
Créer un historique d'intégration (erreur) et alerter le contact d'intégration |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
|
Corps de réponse échantillon |
|
Option 3 : bénéficier d’une surveillance complète de l’intégration Coupa
Description
Dans ce scénario, nous créons une exécution d'intégration qui suit
- Statut de l'intégration (en attente/démarrée/en erreur/réussie/échouée)
- Nombre total de bons de commande traités
- Le nombre de succès et d'erreurs
- La liste des erreurs d'intégration et leur statut (résolues ou non)
Pour chaque bon de commande, nous :
- Résoudre l'enregistrement d'historique d'intégration précédent pour le document
- Créer un historique d'intégration
- En cas d'erreur, créez une erreur d'intégration et une alerte pour le contact d'intégration
Vous pouvez surveiller toutes les exécutions d'intégration pour votre intégration à l'adresse :https://<your instance hostname>/integrations/<your integration id>/integration_runs
.
Utilisez la table d'erreurs d'intégration des bons de commande standard pour répertorier tous les bons de commande avec des erreurs d'intégration en attente de résolution. Il est situé à :.https://<your instance hostname>/integration_errors
Utilisez la table de données de l'historique d'intégration des bons de commande standard pour répertorier tous les bons de commande intégrés. Il est situé à :https://<your instance hostname>/integration_history_records/purchase_orders
.
Diagramme d'orchestration
Détails des étapes/appels API
Étape 1 |
Créer une exécution d'intégration |
---|---|
Méthode |
POSTE |
API |
|
Paramètres de requête |
S/O |
Exemple de corps de requête |
|
Corps de réponse échantillon |
|
Étape 2 |
Obtenez la liste et les détails des bons de commande Coupa à créer/mettre à jour dans l'ERP. |
---|---|
Méthode |
OBTENIR |
API |
|
Paramètres de requête |
filter= |
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
Étape 3 |
Démarrer l'exécution d'intégration |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
S/O |
Exemple de corps de requête |
|
Corps de réponse échantillon |
|
Étape 4 |
Marquer chaque BC comme exporté |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
C'est ici que se produit la création/mise à jour du bon de commande dans l'ERP.
Étape 5a |
Obtenir un historique d'intégration non résolu |
---|---|
Méthode |
OBTENIR |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Étape 5b |
Résoudre l'historique d'intégration précédent |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Étape 6a |
Obtenir enregistrement des erreurs d'intégration non résolues |
---|---|
Méthode |
OBTENIR |
API |
|
Paramètres de requête |
|
URL exemple |
|
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Étape 6b |
Résoudre l'historique d'intégration précédent |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
S/O |
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Étape 7a |
Créer un historique d'intégration (réussite) |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
fields=["id","document-id","status"] |
URL exemple |
|
Exemple de corps de requête |
|
Corps de réponse échantillon |
|
Étape 7b |
Créer une erreur d'intégration et alerter le contact d'intégration |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
S/O |
Exemple de corps de requête |
|
Corps de réponse échantillon |
|
Étape 8 |
Terminer l'exécution d'intégration |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
S/O |
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
En cas de défaillance générale pendant l'exécution de l'intégration
Étape x |
Déclencher un échec pour l'exécution d'intégration |
---|---|
Méthode |
METTRE |
API |
|
Paramètres de requête |
S/O |
Exemple de corps de requête |
S/O |
Corps de réponse échantillon |
|
Une partie ou la totalité de cette page peut avoir été traduite par machine. Toutes nos excuses pour les inexactitudes.