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 ESTADOS DE CONTROL.
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.
Control States
# Ejemplo Request HTTP
POST /api/ControlSates HTTP/1.1
Host: apirest.logictracker.com
Content-Type: application/json
{
"IdEmpresa": TU_ID_EMPRESA,
"HashApi": "TU_HASH_API",
"Code": "*",
"RouteCode": "C52598",
"JobCode": "34024834",
"Comment": "Probando alta de estado de control desde API",
"UserName": "NOMBRE_USUARIO"
}
# Ejemplo Request CURL
curl --location --request POST 'https://apirest.logictracker.com/api/ControlSates' \
--header 'Content-Type: application/json' \
--data-raw '{
"IdEmpresa": TU_ID_EMPRESA,
"HashApi": "TU_HASH_API",
"Code": "*",
"RouteCode": "C52598",
"JobCode": "34024834",
"Comment": "Probando alta de estado de control desde API",
"UserName": "NOMBRE_USUARIO"
}'
Para dar de alta un nuevo estado de control asociado a una entrega, debe realizar una llamada POST a la siguiente URL:
https://apirest.logictracker.com/api/ControlStates/
# Ejemplo API Respuesta
{
"response": {
"codigo": 200,
"mensaje": "OK",
"id": 0
}
}
REQUEST BODY PARAMETERS
| Nombre | Tipo | Descripción |
|---|---|---|
| idEmpresa | Int | ID único provisto por Logictracker para el cliente que consulta la API. |
| hashApi | String | HASH único provisto por Logictracker para el cliente que consulta la API. |
| code | String | Código del estado de control que queremos utilizar para realizar el ALTA. Es necesario que exista un estado de control con dicho codigo en plataforma logictracker. |
| routeCode | String | Código de la ruta en la que se buscará la entrega para asociar el estado de control que damos de ALTA. |
| jobCode | String | Código de la entrega para asociar el estado de control que damos de ALTA. |
| comment | String | Comentario del estado de control que damos de ALTA. |
| userName | String | Usuario que da de alta el estado de control (nombre de usuario de plataforma logictracker que utilizan para ingresar). |
RESPONSE PARAMETERS
| Nombre | Tipo | Descripción |
|---|---|---|
| response | GenericResponse |
Objeto que indica una respuesta generica de la API. |
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. |
Errors
La llama a la API de ControlStates/ 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 operar ControlStates. Solicitar habilitación uso de API a LOGICTRACKER. |
| 403 |
Hash invalido para consultar API. Asegurese que hashApi provisto por LOGICTRACKER sea el correcto.
|
| 404 | No existe ruta con codigo enviado. |
| 405 | No existe entrega con codigo enviado. |
| 406 | No existe usuario con nombre enviado. |
| 407 | No existe estado de control con codigo enviado. |
| 500 | Excepcion en api/ControlStates. Entre en contacto con el area de sistemas de LOGICTRACKER y envie el CONTENIDO DEL REQUEST para ser analizado. |