Resumen de la API

QELM ofrece una API JSON para conectar otras herramientas a tu espacio de trabajo y para la app móvil de QELM. Esta página es un resumen de cómo funciona la API: dónde vive, cómo se versiona, cómo te autenticas y qué aspecto tienen las solicitudes y las respuestas.

URL base

Todas las solicitudes a la API se dirigen a:

https://api.qelm.app

La API es un servicio JSON con alcance de espacio de trabajo: las solicitudes actúan dentro del espacio de trabajo de una sola empresa y las respuestas contienen únicamente los datos de ese espacio de trabajo.

Versionado

La API se versiona en la ruta. La versión actual es v1:

https://api.qelm.app/api/v1/...

Fijar una versión significa que una revisión futura no cambiará en silencio la forma de las respuestas de las que depende tu integración. El comportamiento nuevo e incompatible se publica bajo una nueva ruta de versión en lugar de romper la existente.

Autenticación

Cómo te autenticas depende de qué esté llamando a la API:

Sesiones web — cuando tienes una sesión iniciada en tu espacio de trabajo en el navegador, las solicitudes se autentican con tu sesión.
Móvil e integraciones — la app móvil y otros clientes programáticos se autentican con un token de tipo bearer enviado en la cabecera Authorization:
```
Authorization: Bearer <token>
```

En ambos casos, cada solicitud autenticada está ligada a un único espacio de trabajo, y la API solo devuelve datos pertenecientes a ese espacio de trabajo.

Formato de solicitud y respuesta

Las solicitudes y las respuestas son JSON. Envía Content-Type: application/json en las solicitudes que incluyan un cuerpo. Las respuestas correctas devuelven el recurso correspondiente en JSON; los errores devuelven un cuerpo JSON que describe qué salió mal, junto con el código de estado HTTP adecuado.

Integrarse con QELM

Construye sobre las rutas versionadas /api/v1 y autentícate con un token de tipo bearer, y tu integración se mantendrá al día con la API a medida que evoluciona. Si necesitas la forma exacta de un endpoint concreto, escríbenos desde Soporte y te indicamos cuál es.