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

Introduction

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
La fonctionnalité de requête générique permet de créer des vues/requêtes de données via des formulaires au sein de l'instance, qui peuvent ensuite être exposées à l'API.

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 DAC permettent de récupérer des données à partir des DAC ainsi que 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

Récupération des documents supprimés

Outre la récupération des enregistrements existants, Acumatica permet également de suivre les enregistrements supprimés . Cela aide à assurer la mise à jour des systèmes intégré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 Point de terminaison des services Web – SM2070PL ou peuvent être récupérés via l'API.

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 via l’API

Des actions telles que « Libérer » dans les Factures et Ajustements peuvent être exécutées via l’API. Ça devrait être après l’appel. Plus de détails

Récupération des données à partir du rapport
Les données des rapports peuvent être récupérées via 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, leurs détails spécifiques peuvent être ajoutés au point de terminaison par défaut. De même, les détails absents du point de terminaison par défaut peuvent être ajoutés aux points de terminaison étendus .

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

L'utilisation du cadre OAuth et OpenID pour la connexion à Acumatica est recommandée. Il est préférable de concevoir l'intégration avec ce cadre afin de limiter la dette technique et d'assurer la sécurité. Plusieurs flux d'autorisation sont disponibles et leurs cas d'utilisation sont détaillés ci-dessous.

Écran utilisé : SM303010

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

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

Récupération localisée des données

Tant qu’un langage local est défini dans l’instance, les détails peuvent être récupérés dans un autre local 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