API para Desarrolladores
La API para Desarrolladores de Joystick te permite acceder y modificar programáticamente los recursos y configuraciones de tu Producto, incluyendo cualquiera de los entornos, webhooks, esquemas, configuraciones y más que forman parte del Producto. Esto permite potentes automatizaciones, flujos de trabajo e integraciones.
Primeros Pasos
- Solicita acceso. Comunícate con nuestro equipo para habilitar el acceso a la API para Desarrolladores para tu organización.
- Crea una Clave API de Producto.
- ¡Utiliza la API para Desarrolladores!
Funcionalidades de Ejemplo
Muchas de las funciones que normalmente tendrías que realizar a través del CMS de Joystick ahora se pueden acceder a través de la API.
- Crear una nueva Configuración.
- Actualizar una Configuración.
- Sincronizar configuraciones entre entornos.
- Crear solicitudes de implementación para configuraciones entre entornos.
- Visualizar Configuraciones en múltiples entornos.
Gestión de Claves API
Se requiere una Clave API de Producto para utilizar la API para Desarrolladores. La Clave API de Producto solo tendrá acceso a todas las entidades que pertenecen a ese Producto dentro de Joystick. Los usuarios deben tener el permiso 'Editor' o 'Propietario' en la Organización para gestionar las Claves API de Producto.
Navega a la vista de tu Producto. Haz clic en "Configuración del Producto" en la parte superior derecha.
Haz clic en Gestionar Claves API de Producto
Niveles de Acceso
| Nivel de Acceso | Descripción |
|---|---|
| Solo Lectura | Acceso a la mayoría de los endpoints GET. |
| Acceso Básico | Puede crear, actualizar, archivar configuraciones, sincronizar configuraciones, crear solicitudes de implementación. Sin capacidad para modificar, eliminar o archivar otras entidades. |
| Acceso Completo | Control total sobre todas las entidades, incluida la capacidad de eliminar y archivar. |
¿Necesitas Ayuda?
Por favor, comunícate con nuestro equipo si necesitas ayuda o requieres acceso adicional.
Uso de la API
La Clave API de Producto se puede utilizar con muchos de los endpoints de gestión. Puede utilizarse para gestionar tu Producto, Entornos, Contenido de Configuración, Sincronizar Configuraciones y mucho más.
Solicitud
Endpoints
Encuentra la lista completa de endpoints aquí: https://capi.getjoystick.com/developer-api.Encabezado
| Encabezado | Valor | Requerido | Notas |
|---|---|---|---|
x-product-api-key |
Tu Clave API de Producto | Sí | La clave API creada para el PRODUCTO al que te diriges. NO es la misma clave API que se utiliza para la recuperación de configuración. |
Solución de Problemas
¿Tienes problemas? Por favor, comunícate con nuestro equipo en Discord con cualquier pregunta o solicitud.
Notas
Uso de API y Seguridad
- Las solicitudes con Clave API de Producto cuentan como 3 veces más hacia tu uso de API.
- Las Claves API de Producto presentan riesgos, incluida la eliminación completa de tus datos. Por favor, protege y utiliza tus claves API de Producto con cuidado.
- NO crees claves, especialmente claves de Acceso Completo, a menos que estés seguro de que las necesitas.
- Esta función está sujeta a cambios.