Si quieres realizar la integración vía API te damos algunos consejos para ponerte en marcha.
Configuración desde el área de clientes
El primer paso será acceder a tu área de clientes y realizar los siguientes pasos:
2. Crear uno (o varios) Centros de Distribución, en el apartado Configuración > Centros de Distribución
3. Configurar datos de pago en perfil de Deliverea, accede a tu perfil a través de la barra del menú superior y clica en Mi perfil.
Una vez realizados todos estos pasos ya tendrás la configuración para iniciar el proceso de integración con la API de Deliverea. Es importante seguir los pasos de la configuración inicial para evitar errores cuando inicies el proceso de integración con la API.
API
Para acceder al apartado donde encontrarás la información de cómo integrarte via API, tienes que clicar en el menú superior, y en el desplegable clica en Conexión API:
En cuanto al flujo de la integración te presentamos un esquema que te permite visualizar cómo está estructurada la API de Deliverea:
Siempre recomendamos iniciar el proceso con el método GET-SERVICE-INFO, que facilita información sobre los parámetros requeridos, opcionales, servicios adicionales y posibles valores para el servicio del carrier que se indique. Este paso es importante, ya que dependiendo del servicio seleccionado, pueden variar los campos de entrada para crear un nuevo envío. Al tener integrado este método, te garantiza no tener problemas en el momento que quieras añadir un nuevo carrier o nuevo servicio.
Una vez has integrado el GET-SERVICE-INFO puedes continuar con el resto de métodos en función del carrier, el tipo de servicio y las funcionalidades que vas a utilizar de Deliverea.
A continuación te resumimos qué hace cada método disponible a través de la API:
- Get Wizard - El método Wizard es un endpoint para informar sobre los campos requeridos y campos opcionales para la creación de un envío (shipment). El “carrierCode" y "serviceCode" se obtienen con los métodos de carrier y service.
- Get Carriers - método que permite recuperar datos, la información del carrier y las credenciales que has insertado.
- Get services - permite recuperar los datos de cada servicio que necesitas para crear un envío.
- Shipments:
- POST Shipments - permite la creación de envíos
- Get Shipments - permite recuperar datos de uno o varios envíos. Con este método podrás especificar varios condicionales para filtrar los resultados.
- Post Download Label (jwt) - permite descargar las etiquetas.
- Collections: permite la creación de recogidas o devoluciones?
- Post Collections
- Get Collections: método para recuperar los collections según algún parámetro (shipping reference)
- Get single collection info
- Trackings: el ID tracking contiene toda la información de seguimiento de un paquete. Cada ID tracking se actualiza continuamente en segundo plano a medida que el paquete avanza en su ciclo de vida:
- Get Single shipment trackings: el propósito de GET Trackings es llamar a todos los envíos con su estado de seguimiento.
- Get POD: permite obtener POD (Comprobante de entrega). Para recuperar el POD se necesita una referencia única como entrada para la solicitud de POD.
- Distribution Centers:
- Get Distribution Centers- obtiene los centros de distribución del cliente.
- Get Drop points: obtención de puntos de conveniencia habilitados para un determinado código postal.
- JWT - recupera un token de formato json (Json Web Token) que se utiliza para el método de post download label, entre otros.
Puedes revisar toda esta información en la documentación API y empezar la integración con Deliverea.