Déverrouillage des services Web Acumatica : API REST, OData et meilleures pratiques d’intégration

Ce blogue explore le puissant cadre de services Web d’Acumatica, y compris l’API REST, OData, les notifications push et les webhooks, pour aider les entreprises à optimiser les intégrations et à améliorer les fonctionnalités de l’ERP.
Varthini Bhaskaran | 20 août 2025
Page d’accueil / Blog
Août 20, 2025

Déverrouillage des services Web Acumatica : API REST, OData et meilleures pratiques d’intégration

Varthini Bhaskaran Varthini Bhaskaran
Gestionnaire de compte technique principal @ Acumatica

Acumatica dispose d’une solide plateforme d’intégration d’API, y compris REST API ET ODATA. Le tableau suivant fournit des détails :

 

ODATA – Basé sur l’IG

Identifiant de l’écran : SM208000
L’enquête générique permet de créer des vues/requêtes de données par le biais de formulaires dans l’instance, qui peuvent ensuite être exposés à l’API. Plus de détails sur la configuration peuvent être trouvés ici.

Exemple de cas d’utilisation : Données IG complexes, c’est-à-dire une requête complexe pour récupérer les données qui devraient être exposées via API et également exportées au format Excel ou visualisées sur le ERP

Basé sur ODATA DAC

Les appels ODATA basés sur les DAC permettent de récupérer des données des DAC et également des données connexes.

Example call: {{instance}}/t/<TenantName>/api/odata/dac

Example Use-Case: Integrating with POWER_BI reports or new  reporting system for financial analysis

Plus de détails à ce sujet et les capacités de filtrage pour ODATA peuvent être trouvés dans l’article d’aide

Récupération des documents supprimés

En plus de récupérer les dossiers existants, Acumatica permet également de faire le suivi de ceux qui ont été supprimés. Cela permet de s’assurer que les systèmes d’intégration sont à jour. L’article fournit plus de détails sur la façon de récupérer les documents supprimés.

API REST basée sur des contrats

Grâce à l’API REST, nous serons en mesure de récupérer, de créer et de mettre à jour des enregistrements dans l’ERP et également d’exécuter des actions sur les écrans via l’API. De plus, les fichiers et les images peuvent être joints aux enregistrements par l’intermédiaire de l’API. Pour y parvenir, Acumatica a des points de terminaison par défaut prédéfinis et permet également d’étendre/ajouter au point de terminaison par défaut, des champs personnalisés ou de nouvelles entités. Enfin, les données peuvent être filtrées, récupérées par lots ou même un seul enregistrement peut être extrait.

Exemple rapide :

Retrieve all records: {{instance}}/entity/Default/24.200.001/SalesOrder

Retrieve one record: {{instance}}/entity/Default/24.200.001/SalesOrder/a6295b33-c7f6-e811-b817-00155d408001

Ici, le premier appel récupère toute la commande client dans le système et le second récupère une seule commande client avec un GUID – a6295b33-c7f6-e811-b817-00155d408001

Voir tous les points de terminaison disponibles

Les points de terminaison prédéfinis se trouvent sur l’écran Web Services Endpoint – SM2070PL ou ils peuvent être récupérés via l’API. Cet article devrait vous être utile.

Versions de l’API REST

Filtrage et pagination

Pourquoi en avons-nous besoin : Pour éviter les erreurs de délai d’attente et augmenter les performances
Principale technique de filtrage :

  • $expand
  • $filter
  • $top
  • $skip

Exemple : $filter= 'LastModifiedDateTime' gt '2024-02-18T23%3A59%3A59.999%2B04%3A00'

Cela permet aux utilisateurs de récupérer les données depuis la dernière synchronisation. Plus de détails

Exécution d’actions par l’intermédiaire de l’API

Des actions telles que « Release » dans les factures et les rajustements peuvent être exécutées par l’intermédiaire de l’API. Cela devrait être après l’appel. Plus de détails

Extraire des données du rapport
Les données des rapports peuvent être récupérées au moyen de l’API. Plus de détails

Example:
POST {{instance}}/entity/Report/0001/CashAccountSummary

Organisme de la demande :

{

“CompanyBranch”: {“value”: “SOFT”},

“IncludeNonClearedTransactions”: {“value”: true}

}

Étendre le point de terminaison par défaut et créer un nouveau point de terminaison

Écran : SM207000

Si des champs personnalisés et de nouveaux écrans sont ajoutés à l’instance, les détails spécifiques à ceux-ci peuvent être ajoutés au point de terminaison par défaut. De plus, les détails qui ne sont pas présents dans le point de terminaison par défaut peuvent être ajoutés aux points de terminaison étendus. Vous trouverez plus de détails sur la façon de créer et d’utiliser ces points de terminaison étendus personnalisés ici

 

Rendre les points de terminaison personnalisés partageables / Ajouter à un forfait de personnalisation

Écran : SM204505

Rend l’API REST partageable par le biais de projets de personnalisation. Plus de détails

 

Notification poussée

ID d’écran : Notifications poussées (SM302000)

Les notifications push permettent aux applications externes de suivre les changements de données dans Acumatica

Les notifications poussées autorisent les applications externes

  • Pour envoyer des avis sur les changements apportés à des données particulières.
  • Mettre en œuvre la synchronisation en temps réel des changements dans les données d’Acumatica ERP avec les données d’un système externe.

Configurer Acumatica ERP pour envoyer des notifications poussées pour une requête définie comme une classe dans le code source de l’application, c’est-à-dire pour une définition intégrée de la requête. Plus de détails

 

 

Webhooks

Écran : Webhooks (SM304000)

Un webhook vous aide à intégrer des applications externes qui fournissent des données dans leur propre format et qui doivent soumettre ces données à l’ERP Acumatica.  Les données peuvent être mises en correspondance avec des enregistrements pertinents dans Acumatica. Plus de détails

Authentification et autorisation

Utilisation du framework OAUTH et OPENID pour se connecter à Acumatica. Il est préférable de concevoir l’intégration à l’aide de ce cadre pour éviter la dette technique et assurer la sécurité. Les multiples flux d’autorisation à utiliser et le moment de l’utilisation sont détaillés ci-dessous. Pour plus d’informations sur la configuration et l’utilisation, cliquez ici

Écran utilisé : SM303010

Modification de la date d’affaires et de la succursale lors de l’utilisation de l’API

En utilisant les valeurs d’en-tête PX-CbApiBusinessDate et PX-CbApiBranch, nous pouvons modifier la date commerciale actuelle et la branche utilisée par l’API. Ceci est nécessaire lorsque la date et la branche actuelles influencent la fonctionnalité. Cela permet de définir les autorisations et la date de la succursale, par exemple, la date de génération de la facture. Plus de détails

Récupération de données localisées

Tant qu’une langue locale est définie dans l’instance, les détails peuvent être récupérés dans une autre langue via l’API. Plus de détails

Example call: {{instance}}/entity/Default/24.200.001/StockItem?$expand=Translations

Autorisations des utilisateurs :

Des paramètres tels que le nombre maximal d’utilisateurs de l’API de services Web, le nombre maximal de demandes d’API de services Web par minute et les restrictions de licence peuvent être consultés / examinés via l’instance.

Identifiant de l’écran : SM604000

Plus de détails

Lectures complémentaires :

Formation : I – cours pour les services Web
Articles d’aide avec exemples

Auteur du blog

Gestionnaire de compte technique principal @ Acumatica
Catégories : Développeurs

Recevez des mises à jour de blog dans votre boîte de réception.