Desbloqueo de los servicios web de Acumatica: API REST, OData y mejores prácticas de integración

Introducción

Acumatica dispone de una sólida plataforma de integración API que incluye REST API y ODATA. El siguiente gráfico proporciona detalles:

ODATA - Basado en IG

ID de pantalla: SM208000
La función «Consulta genérica » permite crear vistas de datos o consultas mediante formularios dentro de la instancia, que posteriormente pueden exponerse a través de la API.

Ejemplo de caso de uso: Datos IG complejos, es decir, consulta compleja para recuperar los datos que deben exponerse a través de la API y también exportarse como Excel o visualizarse en el ERP.

Basado en DAC ODATA

Las llamadas ODATA basadas en DAC permiten recuperar datos de los DAC, así como datos relacionados.

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

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

Recuperación de registros eliminados

Además de recuperar los registros existentes, Acumatica también permite realizar un seguimiento de los que se han eliminado. Esto ayuda a garantizar que los sistemas integrados estén actualizados.

API REST basada en contratos

Usando REST API, podremos recuperar, crear y actualizar registros en el ERP y también ejecutar acciones en las pantallas a través de la API. Además de esto, los archivos y las imágenes se pueden adjuntar a los registros a través de la API. Para lograr esto, Acumatica ha pre-construido puntos finales por defecto y también permite extender / añadir al punto final por defecto, cualquier campo personalizado o nuevas entidades. Por último, los datos se pueden filtrar, recuperar por lotes o incluso extraer un único registro.

Ejemplo rápido:

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

La primera llamada recupera todos los pedidos de venta del sistema y la segunda recupera un único pedido de venta con un GUID - a6295b33-c7f6-e811-b817-00155d408001

Ver todos los puntos finales disponibles

Los puntos finales predefinidos se pueden consultar en la pantalla «Puntos finales de servicios web – SM2070PL» o se pueden obtener a través de la API.

Versiones de la API Rest

Filtrado y paginación

Por qué lo necesitamos: Para evitar errores de tiempo de espera y aumentar el rendimiento
Principal técnica de filtrado:

• $expandir
• $filtro
• $superior
• omitir

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

Esto permite a los usuarios recuperar datos desde la última sincronización. Más información

Ejecución de acciones a través de la API

Acciones como "Liberar" en Facturas y Ajustes pueden ejecutarse a través de API. Esto debe ser posterior a la llamada. Más detalles

Recuperación de datos de informes
Los datos de los informes se pueden recuperar a través de la API. Más detalles

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

Cuerpo de la solicitud:

{

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

“IncludeNonClearedTransactions”: {“value”: true}

}

Ampliar el punto final predeterminado y crear un nuevo punto final

Pantalla: SM207000

En caso de que se añadan campos personalizados y nuevas pantallas a la instancia, los datos específicos de estos se pueden añadir al punto final predeterminado. Asimismo, los datos que no figuren en el punto final predeterminado se pueden añadir a los puntos finales ampliados.

Hacer compartible un punto final personalizado / Añadir a un paquete de personalización

Pantalla: SM204505

Hace que la API REST se pueda compartir a través de proyectos de personalización. Más información

Notificación Push

ID de pantalla: Notificaciones Push (SM302000)

Las notificaciones push permiten a las aplicaciones externas seguir los cambios de datos en Acumatica

Las notificaciones push permiten aplicaciones externas

• Para enviar notificaciones sobre cambios en determinados datos.
• Para implementar la sincronización en tiempo real de los cambios en los datos de Acumatica ERP con los datos de un sistema externo.

Para configurar Acumatica ERP para enviar notificaciones push para una consulta que se define como una clase en el código fuente de la aplicación, es decir, para una definición incorporada de la consulta. Más detalles

Webhooks

Pantalla: Webhooks (SM304000)

Un webhook le ayuda a integrar aplicaciones externas que proporcionan datos en su propio formato y necesitan enviar estos datos a Acumatica ERP. Los datos se pueden asignar a registros relevantes dentro de Acumatica. Más información

Autenticación y autorización

Uso del marco OAUTH y OPENID para iniciar sesión en Acumatica. Lo más recomendable es diseñar la integración utilizando este marco para evitar la deuda técnica y garantizar la seguridad. Existen varios flujos de autorización que se pueden utilizar; a continuación se detalla cuándo debe emplearse cada uno.

Pantalla utilizada: SM303010

Modificación de la fecha comercial y la sucursal al utilizar la API

Utilizando los valores de cabecera PX-CbApiBusinessDate & PX-CbApiBranch, podemos cambiar la fecha comercial actual y la rama que la API está utilizando. Esto es necesario cuando la fecha actual y la sucursal influyen en la funcionalidad. Esto permite establecer los permisos de la sucursal y la fecha, por ejemplo, la fecha de generación de la factura. Más información

Recuperación de datos localizados

Siempre que se defina un idioma local en la instancia, los detalles se pueden recuperar en otro idioma local a través de la API. Más detalles

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

Permisos de usuario :

A través de la instancia se puede acceder/revisar la configuración, como el número máximo de usuarios de API de servicios web, el número máximo de solicitudes de API de servicios web por minuto y las restricciones de licencia.

Pantalla ID: SM604000

Para saber más

Más información:

Formación: I - cursos para servicios web
Artículos de ayuda con Ejemplos