Host/URL

La URL para las solicitudes de API depende del dominio base de tu sistema y se compone de la siguiente manera:

https://<system_id>.<server_id>.quentn.com/public/api/<api_version>/<api_endpoint>

Nota: el host HTTP de la URL de la API es el mismo que el de la URL de inicio de sesión.

Todas las solicitudes deben realizarse a través de HTTPS. HTTP no es compatible.

Autenticación

Cada solicitud de API que se realiza debe autenticarse incluyendo un encabezado de autorización con tu clave de API. Puedes encontrar la clave API de tu sistema en la configuración de tu cuenta.

Ejemplo de encabezado:

POST https://your-api-domain-HERE.tdl
Authorization: Bearer Your.API.Key-HERE

Ejemplo con cURL:

curl -X "POST" "https://your-api-domain-HERE.tdl" -H "Authorization: Bearer Your.API.Key-HERE" -H "Content-Type: application/json"

Verbos HTTP

Dependiendo del recurso, admitimos los siguientes verbos HTTP:

Verbo	Descripción
GET	Retrieve a resource or group of resouces
POST	Create a new resource
PUT	Update an existing resource
DELETE	Delete an existing resource

Solicitar: Body

Al enviar datos a través de solicitudes POST o PUT, debes enviar la carga útil en formato JSON.

Ejemplo de solicitud:

POST https://you-api-domain-HERE.tdl HTTP/1.1
Content-Type: application/json
{
  "mail": "johndoe@example.com",
  "first_name" : "John",
  "family_name" : "Doe",
}

Paginación

Algunos recursos GET permiten recuperar información por lotes. Proporcionaremos los argumentos de consulta en la documentación del recurso cuando estén disponibles.

Cuando se solicitan varios elementos, el límite por defecto es de 500 elementos. Puedes especificar un límite diferente, pero no puedes superar el límite predeterminado.