Notas de la versión de la API
2025
Diciembre de 2025
- Routers de Notes y Playbooks (1 de dic.): Se añadieron endpoints de administración de Notes y Playbooks a nivel de Enterprise y de organización a la API v3. Los endpoints de Notes requieren el permiso
ManageAccountKnowledge, y los endpoints de Playbooks requieren el permisoManageAccountPlaybooks.
Noviembre de 2025
- Actualización del límite de paginación (21 de nov.): El límite máximo de paginación se redujo de 1000 a 200 elementos por solicitud para mejorar el rendimiento y la confiabilidad. El límite predeterminado sigue siendo 100. Este cambio NO afecta a la API externa v1.
- Enrutador de sesiones (16 de nov.): Se agregaron endpoints completos de gestión de sesiones a la API v2 para administradores Enterprise.
- Endpoint de la API de snapshots (3 de nov.): Se agregó un endpoint para obtener detalles de snapshots de forma programática.
- Endpoint para terminar sesiones (31 de oct.): Se agregó un endpoint para terminar sesiones en ejecución de forma programática.
Octubre de 2025
- Lanzamiento de la API v3 (23 de oct): Se lanzó la API v3 con compatibilidad completa con RBAC, un modelo de autenticación de usuarios de servicio y un registro de auditoría integral para las acciones de los usuarios de servicio.
- Endpoint de creación de snapshots (30 de oct): Nuevo endpoint de la API de Organizaciones Enterprise v2 para que los administradores de la empresa clonen repositorios de forma programática y creen snapshots con pasos de configuración personalizados y comandos de inicio.
- Mejoras en la API de Playbooks (14 de oct): Se agregó una API para publicar playbooks Enterprise con funcionalidad mejorada para la gestión programática de playbooks.
Septiembre de 2025
- Router de roles (25 de septiembre): Se agregó un router de roles de Enterprise con cinco endpoints de API para gestionar roles de forma programática.
- API de Playbooks (6 de septiembre): Se agregaron endpoints completos de la API de Playbooks a v1 para crear, actualizar, listar y eliminar playbooks de forma programática.
- Endpoint de
secrets(5 de septiembre): Se agregó un nuevo endpointPOST /v1/secretspara crear secretos a través de la API.
Marzo de 2025
- Lanzamiento de la API v2 (23 de marzo): Lanzamos la Enterprise API v2 para administradores de Enterprise, con funciones de gestión de organizaciones, seguimiento del consumo y gestión de miembros.
2024
Octubre de 2024
- Lanzamos una API REST para la creación y administración programática de sesiones
- Endpoints para la creación, supervisión y administración de sesiones
- Compatibilidad con carga y descarga de archivos adjuntos
- Autenticación básica con API keys
- Compatibilidad con la creación idempotente de sesiones
- Casos de uso: revisiones automáticas de pull requests (PR), resolución de errores de lint, migraciones
Política de versionado de API
Compatibilidad con versiones anteriores
- Anunciados con al menos 7 días de anticipación
- Documentados en estas notas de la versión
- Acompañados de guías de migración cuando corresponda
Proceso de obsolescencia
- Anuncio: Anunciaremos la obsolescencia con un cronograma
- Período de obsolescencia: La funcionalidad sigue disponible, pero marcada como obsoleta
- Eliminación: La funcionalidad se elimina después del período de obsolescencia
Compatibilidad de versiones
- v1: Disponible de forma general, con mantenimiento activo
- v2: Disponible de forma general, con mantenimiento activo
- v3: Beta: sujeta a cambios, aún no se recomienda para uso en producción
Guías de migración
Migrar de v1 a v3
- Autenticación: v3 requiere tokens de usuario de servicio en lugar de API keys personales/de servicio
- Autorización: v3 proporciona control de acceso basado en roles (RBAC) con permisos detallados por rol
- Endpoints: v3 usa diferentes patrones de URL (
/v3beta1/*en lugar de/v1/*)
- Crea un usuario de servicio en Enterprise Settings > Service Users
- Asigna los roles apropiados al usuario de servicio
- Genera una API key para el usuario de servicio
- Actualiza tu integración para usar los endpoints de v3
- Realiza pruebas exhaustivas en un entorno no productivo
Migrar de v2 a v3
- Autenticación: v3 utiliza usuarios de servicio en lugar de requerir claves personales de administradores de Enterprise
- Autorización: v3 admite RBAC granular (control de acceso basado en roles) en lugar de acceso limitado solo a administradores de Enterprise
- Alcance: v3 puede limitarse a organizaciones específicas; v2 siempre aplica a toda la cuenta Enterprise
- Necesitas automatización con permisos que no sean de administrador
- Quieres limitar el acceso a la API a organizaciones específicas
- Necesitas una separación clara entre cuentas humanas y de servicio
- Requieres registros de auditoría detallados para acciones automatizadas
Soporte
- Correo electrónico: [email protected]
- Documentación: Descripción general de la API
- Guía de autenticación: Autenticación y API keys