La consulta del maestro de clientes por API devolverá toda la información que Polpoo tiene almacenada de cada uno de los clientes dados de alta.
La exportació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://v2.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. Consultar la información de cliente #
Los parámetros de conexión de la conexión API constan de dos posibles variables para poder consultar únicamente la información requerida. En caso de no enviar ninguna de las dos variables, la API responderá con la base de datos de cliente completa. Las dos variables son:
Id de cliente (id): Consultar toda la información almacenada del cliente por identificador único.
Nombre de cliente (name): Consultar toda la información almacenada del cliente por nombre.
URL: http://v2.restapi.polpoo.com/api/delivery_point_datatables
Ejemplo 1: http://v2.restapi.polpoo.com/api/delivery_point_datatables?id=1054
Ejemplo 2: http://v2.restapi.polpoo.com/api/delivery_point_datatables?name=carniceria
MÉTODO: GET
CONTENIDO: application/json
4. Especificaciones del campo #
La información que devuelve la API es muy extensa. Los campos descritos a continuación son los principales motivos de consulta de la API. En caso de necesitar más información acerca de la devolución de información ponte en contacto con un técnico de Polpoo.
data.id string
Identificador único del cliente.
data.companyId integer
Identificador único de la compañía a la que pertenece el cliente.
data.name string
Nombre del cliente.
data.nif string
NIF del cliente.
data.address string
Dirección principal del cliente.
data.serviceTime integer
Tiempo promedio de servicio del cliente (en segundos).
data.deliveryZoneId string
Ruta predefinida del cliente.
data.coordinatesLatitude string
Coordenada de latitud de la dirección de entrega del cliente.
data.coordinatesLongitude string
Coordenada de longitud de la dirección de entrega del cliente.
data.deliveryWindowStart integer
Hora de apertura del cliente (en segudos).
data.deliveryWindowEnd integer
Hora de cierre del cliente (en segundos).
data.postalCode string
Código postal de la ubicación del cliente.
data.phoneNumber string
Teléfono de contacto del cliente.
data.email string
Correo electrónico del cliente.
data.sendDeliveryNoteMail boolean
En caso de ser true, el cliente recibirá el albarán firmado al correo electrónico. En caso de ser false, no se le mandará al correo electrónico.
data.companyAssociatedId string
Identificador único de la compañía asociada del cliente.
data.isActive boolean
En caso de ser true, el cliente estará activo. En caso de ser false, el cliente estará desactivado.
data.population string
Población del cliente.
data.showDeliveryNotePrice boolean
En caso de ser true, los albaranes aparecen con precios. En caso de ser false, los albaranes vendrán sin valorar.