Las API Keys te permiten autenticarte en la API de Databases desde aplicaciones externas, scripts o integraciones. Cada clave puede tener permisos granulares y una fecha de expiración configurable.
Crear una API Key
Accede a la configuración
Ve a Configuración > API Keys desde la barra lateral izquierda.
Haz clic en + Create API key
El botón se encuentra en la esquina superior derecha.
Configura la clave
Completa los siguientes campos:
- Name — Un nombre descriptivo para identificar la clave (ej. “CI Bot”, “Backend Production”)
- Permissions — Selecciona los permisos que necesita la clave
- Expiration — Tiempo de vigencia de la clave
Haz clic en Create
La clave se genera y se muestra una única vez. Cópiala y guárdala en un lugar seguro.
La clave completa solo se muestra una vez al momento de crearla. Si la pierdes, deberás regenerar la clave o crear una nueva.
Permisos disponibles
Los permisos se dividen en dos categorías:
Records (Registros)
| Permiso | Descripción |
|---|
| Read records | Permite leer y buscar registros en las colecciones |
| Create & update records | Permite crear nuevos registros y actualizar existentes |
| Delete records | Permite eliminar registros |
| Permiso | Descripción |
|---|
| Read files | Permite descargar archivos adjuntos |
| Upload files | Permite subir archivos a los registros |
Aplica el principio de mínimo privilegio: otorga solo los permisos que la aplicación realmente necesita. Por ejemplo, un dashboard de lectura solo requiere Read records.
Opciones de expiración
| Opción | Descripción |
|---|
| 7 days | La clave expira en 7 días |
| 30 days | La clave expira en 30 días (por defecto) |
| 60 days | La clave expira en 60 días |
| 90 days | La clave expira en 90 días |
| 180 days | La clave expira en 180 días |
| No expiration | La clave no expira |
Las claves sin expiración no se revocan automáticamente. Úsalas solo cuando sea estrictamente necesario y combínalas con permisos mínimos.
Gestionar API Keys
La tabla de API Keys muestra todas las claves creadas con la siguiente información:
- Name — Nombre de la clave
- Permissions — Permisos asignados
- Key — Los últimos caracteres de la clave (enmascarada)
- Created — Fecha de creación
- Expires — Fecha de expiración
Acciones disponibles
- Regenerate — Genera una nueva clave manteniendo el mismo nombre y permisos. La clave anterior deja de funcionar inmediatamente.
- Delete — Elimina la clave permanentemente. Cualquier aplicación que la utilice perderá acceso inmediatamente.
Usar la API Key
Incluye la clave en el header X-Api-Key de tus peticiones HTTP:
curl -s -X GET 'https://tu-instancia.jelou.cloud/api/collections/tu_coleccion/records' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Accept: application/json'
