Saltar al contenido principal

Claves de API

Las claves de API proporcionan a los scripts y las integraciones acceso programático de larga duración a la API REST sin una sesión de navegador.

Emitir una clave​

Crea una clave de dos maneras:

  • En la aplicación, desde Configuración → Claves de API.
  • A través de la API, con POST /api/v1/keys y un name:
curl -X POST https://<your-host>/api/v1/keys \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "ci-export-bot" }'

La respuesta contiene la clave completa, que comienza con ef_live_.

aviso

El valor de la clave (ef_live_...) se muestra una sola vez. EntityFlow almacena únicamente un hash de la misma; no se puede recuperar nunca más. Cópiala de inmediato y guárdala en un lugar seguro.

Usar una clave​

Envíala como token de portador (bearer token) en cualquier solicitud REST:

curl https://<your-host>/api/v1/diagrams \
  -H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"

Listar y revocar​

Puedes listar y revocar claves en cualquier momento, desde Configuración → Claves de API o a través de los endpoints /api/v1/keys. La revocación de una clave surte efecto de inmediato.

Permisos​

La emisión y revocación de claves requiere el permiso account:manage. Una clave hereda los permisos con ámbito de inquilino (tenant) de la cuenta que la posee.