Crear y gestionar claves API

Nota: Este es un artículo de carácter muy técnico. Por ello, le recomendamos contar con su departamento de TI al leerlo. Si tiene alguna consulta o petición, póngase en contacto con nosotros a través de support@azumuta.com - estaremos encantados de ayudarle.

Las claves API autentican las solicitudes a la REST API de Azumuta. Cada clave pertenece a un dispositivo API en su espacio de trabajo. Usted gestiona esos dispositivos en la página Dispositivos API.

Crear una clave API

1. Vaya a Gestión → Dispositivos → pestaña API. El título de la página es Dispositivos API.
2. Haga clic en el símbolo más amarillo → Añadir dispositivo.
3. Introduzca un Nombre, establezca Tipo en Dispositivo API, luego haga clic en Añadir.

Azumuta crea el dispositivo y genera una clave API para él.

Para más información sobre las páginas de Dispositivos en general, consulte See the list of devices that are logged in on your workspace.

Copiar una clave API

Puede copiar una clave de cualquiera de estas maneras:

• En la lista Dispositivos API, abra el menú de la fila del dispositivo y haga clic en Copiar clave API. Aparecerá un snackbar con Copiado.
• O haga clic en Editar dispositivo, busque Atributos API, y use el icono de copiar junto al campo Clave API.

Autenticar solicitudes API

Envíe la clave en la cabecera de solicitud X-API-Key. Es el método recomendado.

También puede enviar la clave como parámetro de consulta apiKey. Prefiera la cabecera siempre que sea posible.

Todas las solicitudes API deben usar HTTPS. Las solicitudes por HTTP plano fallan. Las solicitudes sin una clave válida también fallan.

Importante: Nunca coloque una clave API en código cliente del navegador, repositorios públicos ni en ningún lugar fuera de la empresa. Trate las claves como credenciales secretas únicamente para integraciones del lado del servidor.

Alcance del entorno

Las claves API están limitadas por entorno. Una clave creada en su host sandbox funciona únicamente en ese entorno sandbox. Una clave de producción funciona únicamente en producción. Usar una clave sandbox contra producción (o viceversa) devuelve un error de autenticación.

Opcional: Alcances de la API

Si el experimento de alcances de API está habilitado para su espacio de trabajo, puede restringir lo que puede hacer una clave. Abra Editar dispositivo → Seguridad, y configure los Alcances de la API. Cuando esa opción no esté disponible en su espacio de trabajo, la clave tiene el acceso predeterminado de un dispositivo API.