Débloquer les services Web d'Acumatica : API REST, OData et meilleures pratiques d'intégration

Introduction

Acumatica dispose d'une plateforme d'intégration API robuste comprenant l'API REST et ODATA. Le tableau suivant fournit des détails :

ODATA - Basé sur l'IG

ID de l'écran : SM208000
La fonctionnalité «Generic Inquiry » permet de créer des vues de données et des requêtes via des formulaires au sein de l'instance, qui peuvent ensuite être exposées via une API.

Exemple de cas d'utilisation : Données complexes de l'IG, c'est-à-dire requête complexe pour récupérer les données qui doivent être exposées via l'API et également exportées sous Excel ou visualisées sur l'ERP.

ODATA basé sur un convertisseur numérique-analogique

Les appels OData basés sur les DAC permettent de récupérer des données à partir des DAC, ainsi que des données associées.

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 garder une trace des enregistrements supprimés. Cela permet de s'assurer que les systèmes intégrés sont à jour.

API REST basée sur les contrats

En utilisant l'API REST, nous pourrons récupérer, créer et mettre à jour des enregistrements dans l'ERP et également exécuter des actions sur les écrans par le biais de l'API. En outre, les fichiers et les images peuvent être attachés aux enregistrements par l'intermédiaire de l'API. Pour ce faire, Acumatica dispose de points de terminaison par défaut prédéfinis et permet également d'étendre/additionner au point de terminaison par défaut tout champ personnalisé ou toute nouvelle entité. Enfin, les données peuvent être filtrées, extraites 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 toutes les commandes clients du 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 sont disponibles dans l'écran « Web Services Endpoint – SM2070PL » ou peuvent être récupérés via l'API.

Versions de l'API Rest

Filtrage et pagination

Pourquoi nous en avons besoin : Pour éviter les erreurs de temporisation et augmenter les performances
Principale technique de filtrage :

• Expansion
• $filtre
• top
• Sauter

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 la "validation" dans les factures et les ajustements peuvent être exécutées par l'intermédiaire de l'API. Cette opération doit être effectuée après l'appel. Plus de détails

Récupération des données d'un 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

Corps de la demande :

{

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

“IncludeNonClearedTransactions”: {“value”: true}

}

Extension du point de terminaison par défaut et création d'un nouveau point de terminaison

Écran : SM207000

Si des champs personnalisés et de nouveaux écrans sont ajoutés à l'instance, les informations qui leur sont spécifiques peuvent être ajoutées au point de terminaison par défaut. De même, les informations qui ne figurent pas dans le point de terminaison par défaut peuvent être ajoutées aux points de terminaison étendus.

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

Écran : SM204505

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

Notification push

ID d'écran : Notifications push (SM302000)

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

Les notifications push permettent l'utilisation d'applications externes

• Envoyer des notifications sur les modifications apportées à des données particulières.
• Mettre en place une synchronisation en temps réel des changements de données dans Acumatica ERP avec les données d'un système externe.

Pour configurer Acumatica ERP afin qu'il envoie des notifications push 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

Crochets Web

Écran : Crochets Web (SM304000)

Un webhook vous aide à intégrer des applications externes qui fournissent des données dans leur propre format et qui doivent les soumettre à Acumatica ERP. Les données peuvent être associées à des enregistrements pertinents dans Acumatica. Plus de détails

Authentification et autorisation

Utilisation du cadre OAUTH & OPENID pour la connexion à Acumatica. Il est recommandé de concevoir l'intégration à l'aide de ce cadre afin d'éviter toute dette technique et de garantir la sécurité. Il existe plusieurs flux d'autorisation, dont l'utilisation est détaillée ci-dessous.

Écran utilisé : SM303010

Modification de la date et de la direction de l'entreprise lors de l'utilisation de l'API

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

Recherche 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 locale par l'intermédiaire de l'API. Plus de détails

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

Autorisations de l'utilisateur :

Les paramètres tels que le nombre maximum d'utilisateurs de l'API de services Web, le nombre maximum de requêtes de l'API de services Web par minute et les restrictions de licence peuvent être consultés/examinés par le biais de l'instance.

Identité d'écran : SM604000

Plus de détails

Pour en savoir plus :

Formation : I - cours pour les services web
Articles d'aide avec exemples