Cómo crear y gestionar claves API

Nota: Se trata de un artículo altamente técnico. Por tanto, recomendamos que involucre a su departamento de TI al leerlo. Si tiene alguna consulta o solicitud, contáctenos en support@azumuta.com; estaremos encantados de ayudarle.

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

Cómo 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 Añadir dispositivo.
3. Introduzca un Nombre, establezca 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 Cómo ver la lista de dispositivos que han iniciado sesión en su espacio de trabajo.

Cómo Copiar una Clave API

Puede copiar una clave de cualquiera de estas maneras:

1. En la lista Dispositivos API, abra el menú de fila del dispositivo y haga clic en Copiar clave API. Aparecerá un mensaje tipo snackbar con el texto Copiado.
2. O haga clic en Editar dispositivo, busque Atributos de API, y utilice el icono de copia junto al campo Clave API.

Cómo Autenticar Solicitudes a la API

Envíe la clave en el encabezado de solicitud X-API-Key. Ese es el método recomendado.

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

Todas las solicitudes a la API deben usar HTTPS. Las solicitudes por HTTP sin cifrar fallarán. Las solicitudes sin una clave válida también fallarán.

Importante: Nunca incluya una clave API en el código cliente del navegador, en 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 están vinculadas al entorno. Una clave creada en su host sandbox funciona solo contra ese entorno sandbox. Una clave de producción funciona solo en producción. Usar una clave de sandbox contra producción (o al revés) devuelve un error de autenticación.

Opcional: Alcances de la API

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