Autorización

En esta sección aprenderás a generar un token de autorización para poder enviar peticiones al API.

POSThttps://enterprise.api.trato.io/api/authentication/token

Generar JWT

Para generar el token de acceso, deberás enviar el usuario y password asociados a tu cuenta de TRATO a través de la siguiente llamada.


  • Name
    email
    Type
    string
    Description

    Usuario para acceder al panel de TRATO.

  • Name
    password
    Type
    string
    Description

    Contraseña para acceder a TRATO. mínimo 11 caracteres.


Response attributes

  • Name
    success
    Type
    string
    Description

    Indica si la configuración del contrato fue exitosa (true/false).

  • Name
    jwt
    Type
    string
    Description

    El JSON Web Token generado por el api.

  • Name
    ttl
    Type
    integer
    Description

    Tiempo de vigencia del token en segundos.

  • Name
    error
    Type
    string
    Description

    En caso de existir algún error, se indicará en este parámetro.

Request

POST
/api/authentication/token
curl -G https://enterprise.api.trato.io/api/authentication/token \
  -d email=user@trato.io \
  -d password=pass123tets

Response

{
  "success": true,
  "jwt": "iOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2",
  "ttl": 300,
  "error": ""
}

Api Key

Para usar el api key, deberás enviarlo a traves de un Header llamado "apikey". Si mandas el apikey en un header no es necesario generar el JWT

Ejemplo de petición usando apikey

curl https://enterprise.api.trato.io/api/authentication \
  -H "apikey: {apikey}"

Mantén siempre su token ó apikey seguro para que no sea comprometido.


Protección de las urls de los archivos

En caso de tener habilitada dicha protección en el TENANT, lo que cambia es como se obtiene el contenido de los archivos, por lo que con esto es necesario tener una sesión válida, por lo que nadie que no este autorizado podrá obtener el archivo.

Ejemplo

Cambia de https://upload.trato.io/332fcb56-da8f-432f-879a-8ddee565c289.pdf
a https://enterprise.api.trato.io/uploads/624b726200a14793dfb01cde