Claves API

Una clave de API permite que otro programa utilice la API de AurionAI para su organización. Cada clave tiene una lista de permisos, denominados ámbitos. Una clave solo puede realizar las acciones que sus ámbitos permiten.

Disponibilidad: todos los perfiles. Solo administradores.

Requisitos previos

• Tiene el rol Propietario o Administrador. Los demás usuarios ven Acceso denegado.
• Sabe qué necesita hacer el programa, para asignarle únicamente los ámbitos que necesita.

Abrir las claves de API

1. En la barra lateral, seleccione Configuración.
2. Abra la categoría Sistema.
3. Seleccione Claves API.

La tabla Claves activas muestra el nombre, el inicio de la clave, los ámbitos, el estado, la fecha de creación, el último uso y la fecha de vencimiento de cada clave. Las claves revocadas aparecen en Claves revocadas.

Crear una clave

1. Seleccione Crear clave.
2. En Nombre, escriba un nombre que indique qué programa utiliza la clave.
3. Opcional: en Descripción (opcional), describa para qué sirve la clave.
4. En Caducidad, elija cuándo vence la clave. El valor predeterminado es 90 días. También puede elegir Sin caducidad.
5. En Permisos, seleccione los ámbitos. Una casilla de grupo selecciona todos los ámbitos del grupo.
6. Seleccione Crear clave.
7. Copie la clave con Copiar clave API. AurionAI muestra la clave completa solo esta vez.
8. Seleccione La he copiado — descartar.

El programa envía la clave en la cabecera X-API-Key de cada solicitud. Una clave comienza con itsm_sk_live_, o con itsm_sk_test_ en el caso de una organización de pruebas.

Ámbitos

Notas sobre los ámbitos:

• Para publicar artículos de la base de conocimiento con imágenes, una clave necesita kb:read, kb:write y kb:media. Solo con kb:read y kb:write, no puede cargar imágenes. No existe ningún ámbito para eliminar artículos.
• Para exportar la transcripción de una llamada, una clave necesita conversations:read, conversations:write y conversations:export; las claves creadas antes de que existiera conversations:export no pueden exportar hasta que cree una clave de sustitución que lo incluya.
• No existe un ámbito de «todos los permisos». Seleccione cada ámbito que el programa necesite.

Rotar una clave

Rote una clave cuando cree que otra persona la conoce.

1. En la columna Acciones de la clave, seleccione Rotar clave.
2. En el cuadro de diálogo Rotar clave API, seleccione Rotar clave.
3. Copie la nueva clave. La clave antigua deja de funcionar. Actualice el programa con la nueva clave.

La nueva clave conserva el nombre, los ámbitos y la fecha de vencimiento de la anterior.

Revocar una clave

1. En la columna Acciones de la clave, seleccione Revocar clave.
2. En el cuadro de diálogo Revocar clave API, seleccione Revocar clave.

Aparece el mensaje Clave API revocada. Los programas que utilizan la clave pierden el acceso de inmediato. Esta acción no se puede deshacer.

Resultado

Una nueva clave funciona de inmediato, únicamente con sus ámbitos. La columna Estado muestra Activa, Caduca pronto durante los últimos siete días antes del vencimiento, Caducada o Revocada.

Si algo va mal

• Seleccione al menos un permiso Seleccione al menos un ámbito.
• No se pudo crear la clave API Inténtelo de nuevo. Si vuelve a fallar, póngase en contacto con el soporte de AurionAI. Consulte Obtener ayuda.
• Secreto no disponible AurionAI no mostró la clave. No utilice esta clave. Revóquela y cree una nueva.
• Ha perdido la clave. AurionAI no puede mostrarla de nuevo. Rote la clave o cree una nueva.
• Una solicitud con la clave es rechazada. A la clave le falta el ámbito para esta solicitud, o bien ha vencido o ha sido revocada. Compruebe las columnas Ámbitos y Estado.
• Un programa no puede cargar imágenes en la base de conocimiento. Añada kb:media: cree una nueva clave con kb:read, kb:write y kb:media.

Artículos relacionados

• API para desarrolladores: uso y webhooks
• Conecte sus herramientas de ITSM y CS
• Obtener ayuda