API REST
Todos los módulos del espacio de trabajo en /api/v1, con los mismos permisos que las pantallas y un contrato OpenAPI 3.1 para generar clientes.
Acceso
El acceso a la API forma parte del plan. Una vez habilitado, el operador de la plataforma entrega la clave del espacio de trabajo; actúa como una cuenta de servicio a la que el administrador asigna un rol con solo los permisos que necesita la integración. Las personas también pueden usar la API con su propia sesión.
- Las llamadas van a la dirección propia del espacio de trabajo y llevan la clave en la cabecera Authorization.
- Los recursos de otro espacio de trabajo responden exactamente como si no existieran.
- El contrato en vivo está disponible, con autenticación, en /api/v1/openapi.json.
curl -H "Authorization: Bearer $DEVGOB_API_KEY" \
"https://acme.portaldevops.com/api/v1/workitems?project_id=$PROJECT&limit=50"Qué cubre
- Proyectos, equipos, sprints, elementos de trabajo, comentarios, adjuntos, relaciones, tiempo e historial.
- Backlog, tableros, soporte y el flujo de cada tipo.
- Validaciones: el checklist, sus responsables, calificaciones, plantillas y su informe en PDF.
- Deployments y Data Changes: fases, comité, pruebas, especificación, autorizaciones, el informe consolidado y el paquete de evidencias.
- Autorizaciones del Caso de Negocio, informes, notificaciones, roles y configuración.
- GitHub, GitLab y Azure DevOps: conexiones, repositorios y los vínculos de cada elemento.
Convenciones
- Las listas se paginan por cursor: 50 por página por defecto, hasta 200, y next_cursor lleva a la página siguiente.
- Cada cuerpo de solicitud se valida de forma estricta: un campo desconocido se rechaza, nunca se ignora.
- Los errores comparten un formato con un código estable; las fechas van en UTC con ISO 8601.
- Los documentos, como PDF y paquetes de evidencias, nunca se guardan en caché y cada descarga se audita.