|   Integración

Soporte

integracion-2-01

API - Integración rutas

|   Integración

integracion-2-01

API - Integración rutas

Soporte

Api - Integración rutas

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.

Hay que decir que esta opción nos creará un fichero JSON como el que hemos detallado en su correspondiente apartado, y que tendremos que cargar en la plataforma. Debe estar codificado en UTF-8.

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 Añadir 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/jason

 

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.

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.

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"
}

La parte más importante de esta respuesta es el valor del token de acceso (access_token), que es lo que se tendrá que usar para la integración de los datos

3. Integración de clientes por API​

Una vez se tenga el usuario o usuarios de perfil técnico, y el token de acceso para la conexión a la API, ya se podrá cargar las datos en la plataforma. Los parámetros de la conexión para la carga de datos son los siguientes:

 

- URL: https://restapi.polpoo.com/api/integration
- MÉTODO: POST
- CONTENIDO:
application/json

 

El esquema de código el mismo que se usa para integración de los datos mediante JSON. Solo se incluyen tres campos nuevos (automáticamente) que únicamente sirven para diferenciar las diferentes integraciones hechas vía API.

 

Junto con estos nuevos tres campos, y como ya se ha dicho, hay que añadir los campos anteriormente especificados en la Integración de Rutas.

 

4. Especificaciones de los campos

name string
Nombre de la integración.

description string
Observaciones de la integración.

dateSession datetime
Fecha de la integración.

** Los campos del deliveryPoints son los mismos
que los de la integración de rutas por SFTP.

5. Ejemplos y descargables

{
name: "Rutas Lunes",
description: "Es la ruta de los lunes",
dateSession: "2020-3-22",
"deliveryPoints": [
{
.....
.....
},
{
...
...
}
]
}

6. ¿Cómo recibo la información en Polpoo?

Una vez cargado satisfactoriamente el fichero delivery_points.json en el SFTP, nuestra plataforma lo absorbe automáticamente añadiendo las nuevas rutas y los clientes que las forman en nuestra base de datos.

Para comprobar la carga correcta del contenido, nos dirigimos al menú Planificar Rutas. Una vez ahí, hay que clicar en el menú + Rutas -> Entregas planificadas.

Se desplegará el listado de las entregas planificadas. En caso de haberse llevado a cabo correctamente la integración de la ruta, deberá aparecer en la tabla un nuevo registro con el nombre que se le ha dado en el fichero .json. Cuando encontramos la ruta deseada, se selecciona y se clica en el botón Seleccionar para cargar en el planificador de rutas.

Api - Integración rutas

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.

Hay que decir que esta opción nos creará un fichero JSON como el que hemos detallado en su correspondiente apartado, y que tendremos que cargar en la plataforma. Debe estar codificado en UTF-8.

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 Añadir 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/jason

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": "tT96kecNtYVf92dvRfQ1Ikj6sjsx5tK

ZzaCCpHun",
"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.

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.

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"
}

La parte más importante de esta respuesta es el valor del token de acceso (access_token), que es lo que se tendrá que usar para la integración de los datos

3. Integración de clientes por API​

Una vez se tenga el usuario o usuarios de perfil técnico, y el token de acceso para la conexión a la API, ya se podrá cargar las datos en la plataforma. Los parámetros de la conexión para la carga de datos son los siguientes:

- URL: https://restapi.polpoo.com/api

/integration

- MÉTODO: POST

- CONTENIDO:
application/json

El esquema de código el mismo que se usa para integración de los datos mediante JSON. Solo se incluyen tres campos nuevos (automáticamente) que únicamente sirven para diferenciar las diferentes integraciones hechas vía API.

Junto con estos nuevos tres campos, y como ya se ha dicho, hay que añadir los campos anteriormente especificados en la Integración de Rutas.

4. Especificaciones de los campos

name string
Nombre de la integración.

description string
Observaciones de la integración.

dateSession datetime
Fecha de la integración.

** Los campos del deliveryPoints son los mismos
que los de la integración de rutas por SFTP.

5. Ejemplos y descargables

{
name: "Rutas Lunes",
description: "Es la ruta de los lunes",
dateSession: "2020-3-22",
"deliveryPoints": [
{
.....
.....
},
{
...
...
}
]
}

6. ¿Cómo recibo la información en Polpoo?

Una vez cargado satisfactoriamente el fichero delivery_points.json en el SFTP, nuestra plataforma lo absorbe automáticamente añadiendo las nuevas rutas y los clientes que las forman en nuestra base de datos.

Para comprobar la carga correcta del contenido, nos dirigimos al menú Planificar Rutas. Una vez ahí, hay que clicar en el menú + Rutas -> Entregas planificadas.

Se desplegará el listado de las entregas planificadas. En caso de haberse llevado a cabo correctamente la integración de la ruta, deberá aparecer en la tabla un nuevo registro con el nombre que se le ha dado en el fichero .json. Cuando encontramos la ruta deseada, se selecciona y se clica en el botón Seleccionar para cargar en el planificador de rutas.