Crear y gestionar claves API

Actualizado

Nota: Este artículo es técnico, por lo que le recomendamos involucrar a alguien con la experiencia técnica adecuada. Si tiene alguna pregunta, contáctenos en support@azumuta.com.

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 administra esos dispositivos en la página Dispositivos API.

Crear una clave API

  1. Vaya a Administración → Dispositivos → pestaña API. El título de la página es Dispositivos API.
  2. Haga clic en el símbolo + amarillo → Añadir dispositivo.
  3. Introduzca un Nombre, establezca el Tipo en Dispositivo API, y 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, vea Vea la lista de dispositivos que han iniciado sesión en su espacio de trabajo.

Copiar una clave API

Puede copiar una clave de cualquiera de estas maneras:

  • En la lista de Dispositivos API, abra el menú de la fila del dispositivo y haga clic en Copiar clave API. Aparecerá un snackbar con el mensaje 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 la petición X-API-Key. Ese es el método recomendado.

También puede pasar la clave como parámetro de consulta apiKey. Prefiera la cabecera cuando sea posible.

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

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

Ámbito del entorno

Las claves API tienen ámbito por entorno. Una clave creada en su host sandbox funciona solo contra ese entorno sandbox. Una clave de producción funciona únicamente contra producción. Usar una clave de 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 una clave puede hacer. Abra Editar dispositivo → Seguridad, y luego configure Alcances de la API. Cuando esa opción no está disponible en su espacio de trabajo, la clave tiene el acceso predeterminado para un dispositivo API.

En esta página