Crear una clave
- Abra Configuración, después Claves API, y elija Crear clave.
- Asígnele el nombre del sistema que la utilizará. Elija un alcance y, opcionalmente, una fecha de caducidad.
- Copie la clave ahora y guárdela en el almacén de secretos de su sistema.
Important: La clave completa se muestra una sola vez. Si la pierde, revóquela y cree otra.
| Alcance | Actúa como |
|---|---|
| Solo lectura | Un lector. Puede consultar lo mismo que un lector. |
| Lectura y escritura | Como máximo, un gestor. Puede crear y modificar lo mismo que un gestor. |
Utilizarla
Envíe la clave en la cabecera Authorization de cada solicitud a la API de la aplicación:
Authorization: Bearer ehk_...
- Una clave solo funciona para su propia organización y solo con su alcance.
- Con una clave no se necesita la cabecera CSRF.
- Una clave no puede crear ni gestionar otras claves.
- Las solicitudes realizadas con una clave se registran en el registro de auditoría como la clave API.
Revocar
Elija Revocar en una clave y dejará de funcionar de inmediato, por lo que los sistemas que la utilicen recibirán errores 401. Una clave también deja de funcionar cuando el miembro que la creó abandona la organización. La lista muestra cuándo se utilizó cada clave por última vez.
Tip: Siempre que sea posible, asigne a cada integración su propia clave de solo lectura. Si una se filtra, solo tendrá que revocar esa.
Para obtener la descripción de la API para sus desarrolladores, solicítela a través del formulario de contacto.