Documentación para el servicio de API REST.

Cliente.

Última actualización 18 Enero 2018.

GET - Obtener todos los clientes

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

Acción de visualizar todos los clientes que se tengan permitidos ver para el usuario con el que se ha logueado.


Headers

Authorization: Token: << token >>


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

Campos de la respuesta
Campo Descripción Tipo
id Identificador del cliente ID
nombre Nombre comercial para la identificación de un cliente string
razon_social Nombre para la identificación string
rfc Registro federal de contribuyentes string
curp En caso de persona fisica string
domicilio Domicilio fiscal string

Ejemplo de respuesta
[
  {
            "id": "Cl-wSIC-0003-Wox3-B9KM",
            "nombre": "Cliente prueba API",
            "razon_social": "Cliente prueba API SA de CV",
            "rfc": "HRTR895FH",
            "curp": null,
            "domicilio": null
  },
  {
            "id": "Cl-wSIC-ZtX3-W546-B9KM",
            "nombre": "Cliente API",
            "razon_social": "Cliente API SAPI",
            "rfc": "CAPI784NRD",
            "curp": null,
            "domicilio": null
  },
  {
            "id": "Cl-wSIC-ZtX3-Wox3-896d",
            "nombre": "Cliente Web Services",
            "razon_social": "Cliente Web Services SRL",
            "rfc": "CW5489GTH",
            "curp": null,
            "domicilio": null
  },
]

GET - Obtener un cliente

https://app.logiety.com/api/v1/clientes/ID-CLIENTE/

Acción de visualizar un cliente en específico por medio del ID, esto funcionará si el usuario tiene acceso y permisos para ese cliente.


Headers

Authorization: Token: << token >>


Ejemplo curl
curl --request GET \
  --url https://app.logiety.com/api/v1/cliente/Cl-smbC-pRde-8zzx-4Gqn/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929'

Ejemplo de respuesta
{
            "id": "Cl-wSIC-0003-Wox3-B9KM",
            "nombre": "Cliente prueba API",
            "razon_social": "Cliente prueba API SA de CV",
            "rfc": "HRTR895FH",
            "curp": null,
            "domicilio": null
}


POST - Agregar un cliente

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

Acción de crear un nuevo cliente para la asignación de contenedores, partidas y fracciones arancelarias de un previo.



Headers

Authorization: Token: << token >>

Content-Type: application/json


Campos de la solicitud

Campo Descripción Tipo
nombre Nombre comercial del cliente string
razon_social Nombre fiscal string
rfc Registro federal de contribuyentes string
curp En caso de persona fisica string
domicilio Domicilio fiscal string

Ejemplo curl
curl --request POST \
  --url https://app.logiety.com/api/v1/clientes/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form 'razon_social=Comercializadora Lopez S.A' \
  --form 'nombre=Comercializadora Lopez'\
  --form 'rfc=HFG984JFG'\
  --form 'curp'\
  --form 'domicilio'

                                    

Campos de la respuesta
Campo Descripción Tipo
id Identificador del cliente ID
nombre Nombre comercial del cliente string
razon_social Nombre fiscal string
rfc Registro federal de contribuyentes string
curp En caso de persona fisica string
domicilio Domicilio fiscal string

Ejemplo respuesta
{
            "id": "Cl-wSIC-0003-Wox3-B9KM",
            "nombre": "Comercializadora Lopez",
            "razon_social": "Comercializadora Lopez S.A",
            "rfc": "HFG984JFG",
            "curp": null,
            "domicilio": null
}
											

PATCH - Modificador un cliente

https://app.logiety.com/api/v1/clientes/ID-CLIENTE/

Acción de modificar los campos del cliente.


Headers

Authorization: Token: << token >>

Campo Descripción Tipo
nombre Nombre comercial del cliente string
razon_social Nombre fiscal string
rfc Registro federal de contribuyentes string
curp En caso de persona fisica string
domicilio Domicilio fiscal string

Headers

Content-Type

application/json

Authorization

<< token >>

Body

razon_social

<< razon_social >>

nombre

<< nombre_comercial >>

Modificar cliente

 curl --request PUT \
  --url https://app.logiety.com/api/v1/cliente/Cl-cyB9-TPh2-ppUq-u4XU/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'Content-Type: application/json' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  --form 'razon_social=Comercializadora S.A de C.V' \
  --form 'nombre=Comercializadora Lopez'

											

Sample Response


{
  "id": "Cl-cyB9-TPh2-ppUq-u4XU",
  "nombre": "Comercializadora Lopez",
  "razon_social": "Comercializadora S.A de C.V"
  "rfc": "HFG984JFG",
  "curp": null,
  "domicilio": null
}
											

DELETE - Eliminar cliente

https://app.logiety.com/api/v1/cliente/ID-CLIENTE/

Acción de eliminar el cliente y toda su información, dicha acción hace que los contenedores, partidas o clasificaciones que haya realizado durante el periodo de uso se borren por completo dentro del sistema del usuario.


Headers

Authorization

<< token >>

Body

Eliminar cliente

curl --request DELETE \
  --url https://app.logiety.com/api/v1/cliente/Cl-EPNf-DtNw-066k-Mtbm/ \
  --header 'Authorization: Token f4f86fc515c85b4da3c0a455e9b708574b4e0929' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW'

											

Sample Response

{
  "mensaje": "El cliente Cl-EPNf-DtNw-066k-Mtbm se ha eliminado con éxito"
}