Saltar al contenido

Resumen de la API

Esta es la API que usan las apps web y móviles de QELM. No hay claves de API para clientes ni tokens de integración, y todavía no hay una referencia pública de endpoints, así que no está preparada para crear tus propias integraciones. Esta página es un resumen de cómo funciona la API: dónde vive, cómo se versiona, cómo se autentican las apps y qué aspecto tienen las solicitudes y las respuestas.

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.

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

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

El comportamiento nuevo e incompatible se publica bajo una nueva ruta de versión en lugar de romper la existente.

Cómo se autentica depende de cuál de las apps de QELM 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.
  • Apps móviles — las apps móviles de QELM te hacen iniciar sesión con tu correo y luego envían el token que reciben en la cabecera Authorization. No puedes crear tokens así para tus propias herramientas.

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.

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.

Si necesitas conectar otra herramienta a tu espacio de trabajo, escríbenos desde Soporte y cuéntanos qué quieres lograr.