Introducción
API Endpoint
https://apirest.logictracker.com/
Nuestra API proporciona acceso programático para leer y actualizar datos de sus principales entidades de negocio, en este caso CREAR CLIENTES.
Para utilizar nuestra API, el cliente necesitará 2 datos fundamentales: IdEmpresa y HashApi . Contáctenos en soporte@logictracker.com para obtener sus credenciales y comenzar a utilizar nuestra API.
Customer Create
# Ejemplo Request HTTP
POST /api/Customer/Create HTTP/1.1
Host: apirest.logictracker.com
Content-Type: application/json
{
"IdEmpresa": TU_ID_EMPRESA,
"HashApi": "TU_HASH_API",
"Code": "3001",
"Description": "NOMBRE CLIENTE 3001",
"CustomerTypeCode": "ENT",
"Address": "Chutro 3135 Capital Federal",
"Mail": "ejemplo@gmail.com",
"Phone" : "1133445566"
}
# Ejemplo Request CURL
curl --location --request POST 'https://apirest.logictracker.com/api/Customer/Create' \
--header 'Content-Type: application/json' \
--data-raw '{
"IdEmpresa": TU_ID_EMPRESA,
"HashApi": "TU_HASH_API",
"Code": "3001",
"Description": "NOMBRE CLIENTE 3001",
"CustomerTypeCode": "ENT",
"Address": "Chutro 3135 Capital Federal",
"Mail": "ejemplo@gmail.com",
"Phone" : "1133445566"
}'
Para dar de alta un nuevO CLIENTE, debe realizar una llamada POST a la siguiente URL:
https://apirest.logictracker.com/api/Customer/Create
# Ejemplo API Respuesta
{
"genericResponse": {
"codigo": 200,
"mensaje": "OK",
"id": 0
},
"possibleDirections": null
}
REQUEST BODY PARAMETERS
| Nombre |
Tipo |
Obligatorio |
Descripción |
| idEmpresa |
Int |
SI |
ID único provisto por Logictracker para el cliente que consulta la API. |
| hashApi |
String |
SI |
HASH único provisto por Logictracker para el cliente que consulta la API. |
| code |
String |
SI |
Código único de identificación del CLIENTE que queremos dar de ALTA. (máximo 32 carácteres) |
| description |
String |
SI |
Nombre / Descripción del CLIENTE. (máximo 128 carácteres) |
| customerTypeCode |
String |
NO |
Código del TIPO DE CLIENTE al que va a pertenecer el nuevo CLIENTE que queremos dar de ALTA. |
| Latitude |
Float |
NO |
Latitud de la ubicación del CLIENTE. |
| Longitude |
Float |
NO |
Longitud de la ubicación del CLIENTE. |
| address |
String |
NO |
Dirección del CLIENTE (lo mas completa posible, por ejemplo Doctor Profesor Pedro Chutro 3135, Buenos Aires). En caso de recibir LATITUD Y LONGITUD, la API ubicará al CLIENTE con esos datos. Si no recibe latitud y longitud, intentará nomenclar al cliente por su dirección. (máximo 255 carácteres). |
| radius |
int |
NO |
Radio en metros, que se utilizará para crear la geocerca del cliente. En caso de no recibir radio, se utilizará 100 que es el valor default. |
| mail |
String |
NO |
Email del cliente. Separar con punto y coma en caso de tener mas de un email (máximo 255 carácteres) |
| phone |
String |
NO |
Teléfono del cliente. Separar con punto y coma en caso de tener mas de uno (máximo 32 carácteres) |
| territoryCode |
string |
NO |
Código de territorio del cliente. (Tiene que existir un territorio creado en plataforma logictracker con dicho codigo) |
| responsibleId |
string |
NO |
Legajo del responsable del cliente. (Tiene que existir un empleado creado en plataforma logictracker con dicho legajo) |
| businessHoursFrom |
string |
NO |
Horario desde de atención del cliente. Formato: HH:MM (hora:minutos) |
| businessHoursTo |
string |
NO |
Horario hasta de atención del cliente. Formato: HH:MM (hora:minutos) |
| comment1 |
string |
NO |
Comentario 1 del cliente. (máximo 255 carácteres) |
| comment2 |
string |
NO |
Comentario 2 del cliente.(máximo 255 carácteres) |
| comment3 |
string |
NO |
Comentario 3 del cliente (máximo 255 carácteres). |
| daysToDelivery |
string |
NO |
Dias de entrega del cliente, Ej: LUN-VIE(9 A 18) SAB (12 A 15). (máximo 255 carácteres). |
| territoryKeyWord |
string |
NO |
Palabra clave asociada a un territorio para realizar la relacion entre el cliente y su territorio. |
| ChannelCode |
string |
NO |
Codigo del canal asociado al cliente. Dicho canal tiene que estar creado previamente en logictracker para poder asociarlo al cliente. |
RESPONSE PARAMETERS
| Nombre |
Tipo |
Descripción |
| genericResponse |
GenericResponse |
Objeto que indica una respuesta generica de la API. |
| possibleDirections |
List<PossibleDirection> |
En caso de que la API encuentre mas de una dirección posible, devolverá la lista de las posibles direcciones. El CLIENTE no será almacenado en Plataforma Logictracker. |
GENERIC RESPONSE PARAMETERS
| Nombre |
Tipo |
Descripción |
| codigo |
Int |
Código respuesta de la API. |
| mensaje |
String |
Mensaje que describe la respuesta de la API. |
| id |
Int |
En caso de generar el alta de una entidad, la API puede devolver el ID de la entidad creada. |
POSSIBLE DIRECTION
| Nombre |
Tipo |
Descripción |
| addres |
string |
Dirección de la posible ubicación del CLIENTE. |
| latitude |
float |
Latitud de la posible ubicación del CLIENTE. |
| longitude |
float |
Longitud de la posible ubicación del CLIENTE. |
Errors
La llama a la API de Customer/Create puede devolver los siguientes códigos de error dentro del objeto GenericResponse
| Código |
Mensaje |
| 200 |
OK
|
| 400 |
Request sin contenido en body, body request null.
|
| 401 |
Consulta sin id de empresa/hash. Asegurese de incluir en su request idEmpresa y hashApi provisto por LOGICTRACKER.
|
| 402 |
Empresa no habilitada para crear clientes. Solicitar habilitación uso de API a LOGICTRACKER.
|
| 403 |
Hash invalido para consultar API. Asegurese que hashApi provisto por LOGICTRACKER sea el correcto.
|
| 404 |
Descripción de cliente nula.
|
| 405 |
No se encontro direccion con address recibido.
|
| 406 |
Varias alternativas para dirección recibida.
|
| 407 |
Request recibido sin datos de Lat-Lon / Address.
|
| 408 |
Código de cliente nulo.
|
| 500 |
Excepcion en api/Customer/Create. Entre en contacto con el area de sistemas de LOGICTRACKER y envie el CONTENIDO DEL REQUEST para ser analizado.
|
