Saltar a contenido

API REST clásica

La API clásica es la interfaz HTTP anterior del espacio de trabajo. Sigue soportada y es el único lugar donde existen algunas operaciones, pero es anterior a la API del espacio de trabajo y usa sus propias convenciones.

URL base

{host}/api/1.0/{espacio}/

Cada recurso se monta debajo, y el nombre del recurso es el primer segmento de la ruta: /api/1.0/starter/cases, /api/1.0/starter/home/inbox.

Autenticación

La API clásica usa OAuth2. Registra un cliente en Clientes OAuth, obtén un token en el endpoint del espacio (/oauth2/token) y envíalo en cada llamada:

Authorization: Bearer <access_token>

Sin token, la API responde 401 con el código 2 y The access token is invalid. Un llamador expirado o no autorizado recibe la misma forma.

Peticiones y respuestas

  • El cuerpo es JSON; envía Content-Type: application/json.
  • Los parámetros de ruta usan dos puntos en la documentación (:app_uid), como en la referencia de endpoints.
  • Las respuestas devuelven los nombres de campo heredados — APP_UID, APP_NUMBER, DEL_INDEX, TAS_UID — no las formas camelCase de la API del espacio de trabajo.
  • Los errores llevan error.code y error.message; 401 es autenticación, 403 permisos, 404 id desconocido.

Qué cubre esta referencia

Los endpoints documentados aquí cubren los recursos que una integración realmente necesita:

Área Qué hace
Casos Listar, leer, actuar y derivar un caso; notas, documentos, variables
Listas del espacio Bandeja, borradores, participados y en pausa, con sus conteos
Listas de casos guardadas Las definiciones que creó un usuario y su exportación
Acciones por correo Las acciones configuradas y sus plantillas
Permisos del proceso Quién puede iniciar un proceso
Tareas iniciales por usuario Qué tareas puede iniciar un usuario

El resto de la API clásica queda fuera a propósito: los recursos obsoletos de móvil y analítica, los de administración que reemplazan las pantallas nuevas, y los endpoints del diseñador que editan los objetos del proceso. La referencia de endpoints indica el conteo y el motivo.

Relacionado