Envío de pedidos por API

Otros

Descarga en PDF la integración de envío de rutas por API

Integración de pedidos por API

La integración de pedidos por API es únicamente para enviar pedidos uno a uno desde fuera hacia Polpoo.

La importación de contenido mediante API requiere de la creación por parte del usuario de un token de acceso. Este token es un string que identifica a un usuario dentro de una aplicación o servicio, para realizar llamadas a la API.

1. Creación del token

Para obtener este token de acceso tendrá que tener un usuario creado en nuestra plataforma con el rol de técnico. En el momento de la creación de la cuenta en Polpoo se creará automáticamente un usuario técnico. Las credenciales de dicho usuario serán enviadas en el correo de bienvenida. En caso de querer crear otra cuenta de usuario de tipo técnico, hay que ir a la sección de Gestión y en la pestaña de Usuarios clicar en + Crear usuario y rellenar todos los campos; indicando el rol de usuario como técnico.

Los parámetros de conexión de la conexión API son los siguientes:

URL: https://restapi.polpoo.com/api/oauth/token_integrator

MÉTODO: POST

CONTENIDO: application/json

Para obtener el token de acceso se deberá hacer una petición API con el siguiente esquema de código

{

 "client_id": 1,
 "client_secret": "tT96kecNtYVf92dvRfQ1Ikj6sjsx5tKZzaCCpHun",
 "username":  "integration@company.com",
 "password":  "secret_password",
 "grant_type": "password"
}

Los campos client_id, client_secret y grant_type son constantes, es decir, no deben modificarse en ningún caso. Por otra parte, los campos username y password sí que son modificables, y deberán rellenarse con los datos del usuario creado anteriormente como técnico. Este usuario os lo facilitará Polpoo.

2. Respuesta de la API

Una vez establecida la conexión y hecha la petición a la API, se recibirá la respuesta por parte de nuestro sistema con el token de acceso.

{

 "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiI",
 "refresh_token": "def50200388a50a45925d65",
 "expires_in": 86400,
 "token_type": "Bearer",
 "username": "integration@company.com"
}

3. Enviar pedidos

Los parámetros de conexión de la conexión API son los siguientes:

URL: https://restapi.polpoo.com/api/integration_session/delivery_point

MÉTODO: POST

CONTENIDO: application/json

4. Especificaciones de los campos

Es importante que la información de los campos no contenga comillas dobles (p.e: «Frutería «El sol»»), ya que los ficheros .json trabajan con comillas dobles para delimitar los campos y la información. En caso de tener algún dato de este estilo, la integración no se realizará correctamente. Cualquier otro símbolo especial es aceptado.

 

Se definen los campos que pertenecen a este fichero de la siguiente manera:


* La información obligatoria está marcada en rojo. En caso de que no se tenga la información de un campo opcional, no se tiene que añadir la etiqueta en el json.


dateSession datetime – obligatorio

Fecha en la que se genera el fichero.

 

name string – obligatorio
Nombre de la importación.

 

 

deliveryPoints.id string – obligatorio
Identificador único del cliente.

 

deliveryPoints.name string – obligatorio

Nombre del cliente.

 

 

deliveryPoints.address string – obligatorio

Dirección del cliente.

 

 

deliveryPoints.deliveryZoneId string – obligatorio
Zona de reparto a la que pertenece el cliente.

 

 

deliveryPoints.population string
Población del cliente.

 

 

deliveryPoints.email string
Correo electrónico del cliente.

5. Ejemplos y descargables

{
"dateSession": "2023-08-19",
"name": "Envío API",
"deliveryPoints": [{
"id": "1050",
"name": "Bar Xaloc",
"address": "Carrer del Torrent Fondo, 08840 Viladecans, Barcelona",
"deliveryZoneId": "Ruta-1",
"population": "Viladecans",
"email": "bar@xaloc.com"
}]
}