Documentación Arcadi API

Introducción

Esta documentación describe la API de Arcadi Envios, la cual permite el acceso a funcionalidades básicas de la plataforma sin necesidad de utilizar la interfaz de la aplicación web. La API está dirigida a desarrolladores que deseen integrar los servicios de Arcadi Envios en sus propias aplicaciones.

Funcionalidades

La API en su versión actual ofrece las siguientes funcionalidades:

  • Listado de países: Permite obtener una lista de todos los países a los que se pueden realizar envíos de remesas.
  • Listado de bancos: Permite obtener una lista de todos los bancos en los que se pueden depositar las remesas.
  • Listado, detalles, creación y actualización de cuentas de destino: Permite gestionar las cuentas de los destinatarios de las remesas, incluyendo la consulta de información, creación, modificación y eliminación.
  • Simulación, listado, detalles y creación de envíos de remesas: Permite realizar simulaciones de envíos de remesas, obtener el listado de envíos realizados, consultar los detalles de un envío específico y crear nuevos envíos.
  • Callback cuando un envío cambie de estado: Recibirá notificaciones cuando el estado de un envío cambia.

Autenticación

Para utilizar la API es necesario obtener un token de autenticación mediante el servicio de autorización. El token debe incluirse en todas las peticiones a la API.

Integración

La API se integra mediante peticiones HTTP a los endpoints expuestos. La documentación de cada endpoint especifica el método HTTP, los parámetros de la petición y el formato de la respuesta.

Los hosts para la API son:
Para producción https://arcadienvios.com
Para pruebas/desarrollo https://pl-arcadi-staging.herokuapp.com

Recursos adicionales

Sitio web de Arcadi Envios: https://arcadienvios.com
Soporte técnico: api@arcadienvios.com

Consideraciones

Se recomienda consultar la documentación de la API regularmente para estar al día de las últimas novedades.

El uso de la API está sujeto a los términos y condiciones de Arcadi Envios.

Esperamos que esta documentación le sea útil para integrar la API de Arcadi Envios en su aplicación.