CRM 360  - Integración de Clientes




REVISIONES


Fecha

Versión

Autor

Descripción

 

1.0Versión Inicial

   

1.1Construcción del documento

 

1.15.0Igualació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

ElementoDescripciónTipo de datoRequerido
companyCodeCódigo de compañía, provisto para la empresa que contrata el servicio.StringSi
lotNúmero de identificación de loteStringNo
customersListado de ClientesJSONSi


{
      "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                          Filearchivo.json



Especificación de Datos


#

Campo

Tipo

Descripción

1codeStringRefiere al código de cliente en la compañía
2typeCodeStringRefiere al tipo de cliente. (Ver especificación)
3activebooleanRefiere a si el cliente esta Habilitado o no
4firstNameStringRefiere al Nombre/s del Cliente
5lastNameStringRefiere al Apellido/s del Cliente
6documentTypeCodeStringRefiere al tipo de documento: DNI, Libreta Cívica, etc.
7documentNumberStringRefiere al número del documento especificado en el Tipo de Documento
8genderStringRefiere al sexo del cliente: Femenino, Masculino, No identificado
9birthCountryCodeStringRefiere al Código de Nacionalidad
10birthdateDateRefiere a la fecha de cumpleaños del cliente
11

emails [{

email

type

}]

lista

Refiere a los correo electrónico del cliente

  • Email
  • Tipo

Ejemplo:

emails:[
{email:"[email protected]", type:'Trabajo'},
{email:"rspirolazzi@gmail", type:'Particular'},
],

12

telephones [{

type
area
number
country

}]


lista

Teléfonos del cliente

  • Tipo
  • Área
  • Número
  • País

Ejemplo:

telephones:[
{type:'Particular', area:11, number:34298179, country:54},
{type:'Trabajo', area:11, number:47478899, country:54},
]

13

addresses [{

type
address
number
floor
department
secondLine
thirdLine
fourthLine
postalCode
city
state
country

}]

lista

Dirección del cliente

  • Tipo de Direccion (trabajo, hogar etc)
  • Dirección
  • Número de la dirección
  • Piso
  • Departamento
  • Segunda línea
  • Tercera línea
  • Cuarta línea
  • Código postal
  • Ciudad
  • Provincia
  • País

Ejemplo:

addresses:[
{ type:'Particular', firstLine:'El Caramba', number:74, ... },
{ type:'Trabajo', firstLine:'Venezuela', number:3158, ... },
]

14

loyaltyCards [{

cardNumber

currentCardAmount

}]

lista

Tarjetas de fidelidad del Cliente

  • String - Número de tarjeta de fidelidad
  • Number - Monto en puntos de la tarjeta


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