Revisiones
Fecha | Versión | Autor | Descripción |
---|---|---|---|
| 1.0 | Versión Inicial | |
| 1.1 | Construcción del documento | |
| 1.15.0 | Viviana García | Igualación Documento a versión actual |
Contenido
Acerca del documento
CRM360 es una solución de Napse para analizar la conducta y el comportamiento de compra de sus clientes, promoviendo así, potenciales oportunidades de interés y retención.
Este manual está destinado a todos los sistemas de punto de venta que se integren con CRM360 mediante el uso de servicio REST o por Archivo.
A continuación, se dará detalle del servicio REST disponible y el de Archivo, destinado a nutrir la base de datos de clientes.
Importación de Clientes
Mediante API REST
Este método posee la especificación detallada ante la creación o actualización de un cliente.
Este servicio permite el envío de hasta 100 datos.
Método REST basado en el formato JSON. Ejemplo:
EndPoint
[POST] https://[dirección-ip]:[puerto]/api/v1/importData/customers
POST - REQUEST
HEADER
Elemento | Valor |
---|---|
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE
BODY
Ejemplo con POSTMAN: Content Type - raw JSON
Elemento | Descripción | Tipo de dato | Requerido |
---|---|---|---|
companyCode | Código de compañía, provisto para la empresa que contrata el servicio. | String | Si |
lot | Número de identificación de lote | String | No |
customers | Listado de Clientes | JSON | Si |
{ "companyCode":"napse", "lot":"100005043", "customers": [...] }
Mediante ARCHIVO
Este método posee la especificación detallada ante la creación o actualización de un cliente.
Este servicio permite el envío de hasta 100 datos.
Método REST basado en el formato JSON. Ejemplo:
EndPoint
[POST] https://[dirección-ip]:[puerto]/api/v1/importData/blob/customers
POST - REQUEST
HEADER
Elemento | Valor |
---|---|
x-access-token | Token obtenido a través del servicio "Authenticate" |
Ejemplo:
x-access-token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJOYXBzZSIsImRhdGEiOnsiX2lkIjoiNjA1ZGQyNTZjZGE0YzhhNzZkODhhNDFiIn0sImlhdCI6MTYyMTQzMTU5OCwiZXhwIjoxNjIxNTE3OTk4fQ.4gxltyla4zKODtM9w0a4-y2_EMtrkIULB9446RSVpKE
BODY
Ejemplo con POSTMAN: Content Type - form-data
Elemento | Valor |
---|---|
file File | archivo.json |
Especificación de Datos
# | Campo | Tipo | Descripción |
---|---|---|---|
1 | code | String | Refiere al código de cliente en la compañía |
2 | typeCode | String | Refiere al tipo de cliente. (Ver especificación) |
3 | active | boolean | Refiere a si el cliente esta Habilitado o no |
4 | firstName | String | Refiere al Nombre/s del Cliente |
5 | lastName | String | Refiere al Apellido/s del Cliente |
6 | documentTypeCode | String | Refiere al tipo de documento: DNI, Libreta Cívica, etc. |
7 | documentNumber | String | Refiere al número del documento especificado en el Tipo de Documento |
8 | gender | String | Refiere al sexo del cliente: Femenino, Masculino, No identificado |
9 | birthCountryCode | String | Refiere al Código de Nacionalidad |
10 | birthdate | Date | Refiere a la fecha de cumpleaños del cliente |
11 | emails [{ type }] | lista | Refiere a los correo electrónico del cliente
Ejemplo: emails:[ |
12 | telephones [{ type }]
| lista | Teléfonos del cliente
Ejemplo: telephones:[ |
13 | addresses [{ type }] | lista | Dirección del cliente
Ejemplo: addresses:[ |
14 | loyaltyCards [{ cardNumber currentCardAmount }] | lista | Tarjetas de fidelidad del Cliente
|
Ejemplo:
{ "code": "0000011000", "active": true, "firstName": "Erick", "lastName": "Thompson", "documentTypeCode": 1, "documentNumber": 11112353, "gender": "M", "birthCountryCode": "ARG", "birthdate": "1995-07-13T23:40:59.084Z", "telephones": [ { "type": "Personal", "area": 11, "number": 60268595, "countryCode": "011" } ], "emails": [ { "type": "Personal", "email": "[email protected]" } ], "addresses": [ { "type": "Personal", "address": "Orn Canyon", "number": 9970, "cityCode": "BSAS_195", "stateCode": "BSAS", "countryCode": "ARG" } ] }