Documentación para servicio API REST.

Usuario.

Última actualización 18 Enero 2018.

GET -Obtener usuarios

https://app.logiety.com/api/v1/usuario/

Acción de visualizar todos los usuarios que han sido creados en el sistema para la elaboración de contenedores y clasificaciones.

Campo Descripción Tipo
id Identificador del usuario ID
nombre Nombre string
apellidos Apellidos string
usuario Nombre único para la identificación string
correo Correo electrónico institucional string
numero_gafete Número del gafete para ingresar a la aduana string
fecha_creacion Fecha de creación del usuario string
estado Indica el estado del usuario (Activo o Desactivo) string
estado_nombre Indica el estado del usuario (Activo o Desactivo) string

Headers

Authorization

<< token >>

Obtener usuarios

curl --request GET \
  --url https://app.logiety.com/api/v1/usuario/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929'

Sample Response

[
{
            "id": "Us-qrHv-VUgP-8bvH-Aill",
            "fecha_creacion": "2018-07-18 10:08:20",
            "usuario": "daniel.alarcon",
            "nombre": "Daniel",
            "apellidos": "Alarcón",
            "correo": "luisnj11@logiety.com",
            "numero_gafete": "123",
            "estado": "AC",
            "estado_nombre": "Activo"
        },
        {
            "id": "Us-eycp-Lvcx-BdoD-aLQm",
            "fecha_creacion": "2018-07-12 21:46:12",
            "usuario": "juan.perez",
            "nombre": "Juan",
            "apellidos": "Perez",
            "correo": "juan1@gmail.com",
            "numero_gafete": "123",
            "estado": "AC",
            "estado_nombre": "Activo"
        },
]

GET Obtener usuario

https://app.logiety.com/api/v1/usuario/<< id-usuario >>/

Acción de visualizar un usuario en específico por medio del ID.

Campo Descripción Tipo
id Identificador ID
nombre Nombre string
apellido Apellidos string
usuario Nombre único para la identificación string
correo Correo electrónico institucional string
numero_gafete Número del gafete para ingresar a la aduana string
fecha_creacion Fecha de creación del usuario string
estado Indica el estado del tramitador (Activo o Desactivo) string

Headers

Authorization

<< token >>

Obtener usuario

curl --request GET \
  --url https://app.logiety.com/api/v1/usuario/Us-ZCWj-8oib-SsTs-rWIx/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929'

Sample Response

{
            "id": "Us-RWXT-llNe-YcTp-33vQ",
            "fecha_creacion": "2018-07-31 17:15:20",
            "usuario": "luis20",
            "nombre": "Luis",
            "apellidos": "Cervantes",
            "correo": "l@gmail.com",
            "numero_gafete": null,
            "estado": "DE",
            "estado_nombre": "Desactivo"
}

POST  Agregar usuario

https://app.logiety.com/api/v1/usuario/

Acción de crear un nuevo usuario para dar de alta contenedores, partidas y clasificaciones. Si es del tipo ejecutivo o administrador tendrá acceso a todos los clientes, si es un clasificador sólo a los clientes que le sean permitidos por el administrador o el ejecutivo.

Nombre Descripción Tipo Atributos
usuario Nombre único para la identificación string requeridos, único
password Código alfanumérico para acceder a la cuenta string requerido
numero_gafete Número del gafete para ingresar a la aduana string
correo Correo electrónico institucional string
nombre Nombre string
apellido Apellidos string
estado Indica el estado del usuario ( Activo o Desactivo ) string

Headers

Authorization

<< token >>

Body

usuario

<< nombre_usuario >>

password

<< contraseña >>

Agregar usuario

curl --request POST \
  --url https://app.logiety.com/api/v1/usuario/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form usuario=jorge_meles \
  --form password=logiety2016
											

Sample Response

{
            "id": "Us-RWXT-llNe-YcTp-33vQ",
            "fecha_creacion": "2018-07-31 17:15:20",
            "usuario": "luis20",
            "nombre": "luis",
            "apellidos": "",
            "correo": "l@gm.com",
            "numero_gafete": null,
            "estado": "DE",
            "estado_nombre": "Desactivo"
}
											

PATCH  Modificador usuario

https://app.logiety.com/api/v1/usuario/<< id-usuario >>/

Acción de modificar los campos del ejecutivo por medio del ID. Los datos de los contenedores, partidas y clasificaciones se asignan a la nueva configuración del usuario.

Nombre Descripción Tipo Atributos
usuario Nombre único para la identificación string único
password Código alfanumérico para acceder a la cuenta string
numero_gafete Número del gafete para ingresar a la aduana string
correo Correo electrónico institucional string
nombre Nombre string
apellido Apellidos string
estado Indica el estado del usuario ( Activo o Desactivo ) string

Headers

Authorization

<< token >>

Body

usuario

<< nombre_usuario >>

password

<< contraseña >>

nombre

<< nombre >>

apellidos

<< apellido >>

correo

<< email >>

numero_gafete

<< numero_gafete >>

Modificar usuario

curl --request PUT \
  --url https://app.logiety.com/api/v1/usuario/Us-iUI6-Biac-vJiB-EOqp/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form usuario=jorge_melecio \
  --form password=ejemplo2018 \
  --form nombre=Jorge \
  --form apellidos=diaz \
  --form correo=jorge@gmail.com \
  --form numero_gafete=12
											

Sample Response


{
            "id": "Us-RWXT-llNe-YcTp-33vQ",
            "fecha_creacion": "2018-07-31 17:15:20",
            "usuario": "luis20",
            "nombre": "luis",
            "apellidos": "Cervantes",
            "correo": "l@gm.com",
            "numero_gafete": null,
            "estado": "DE",
            "estado_nombre": "Desactivo"
}
											

DELETE  Eliminar usuario

https://app.logiety.com/api/v1/usuario/<< id-usuario >>/

Acción de eliminar el usuario y toda su información, si el ejecutivo está asociado a algún contenedor entonces no se permitirá su eliminado.

Headers

Authorization

<< token >>

Body

Eliminar tramitador

curl --request DELETE \
  --url https://app.logiety.com/api/v1/usuario/Us-iUI6-Biac-vJiB-EOqp/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW'

											

Sample Response

{
  "mensaje": "El usuario Us-iUI6-Biac-vJiB-EOqp se ha eliminado con éxito"
}