Acceso por API y documentación de la API

Para qué sirve

Una cuenta de API es un par de claves formado por una clave de API y un secreto de API con el que un sistema de terceros inicia sesión en la interfaz de EasyUC, por ejemplo un sistema de tickets o un sistema de gestión de identidades que hace que se creen usuarios y teléfonos automáticamente.

La página API Documentation muestra las interfaces de esta misma instalación en una interfaz Swagger: endpoints, parámetros, respuestas. Se divide en las áreas default, devices, users, groups, reporting, curri, templates, voicemails y globals.

Requisitos previos

• Una cuenta con el tipo de acceso Administrator (full access) (ROLE_APP_ADMIN) o la cuenta de propietario (ROLE_OWNER). Solo estas cuentas ven el menú Administration.
• Un lugar de almacenamiento seguro para el secreto, por ejemplo una caja fuerte de contraseñas.
• Está definido el propósito de cada cuenta de API. Cree una cuenta independiente para cada sistema de terceros, de modo que pueda revocarla individualmente.

Paso a paso: generar una cuenta de API

1. Abra el espacio de trabajo EasyUC Cisco.
2. Seleccione Administration → Integrations & Communication → API Access. La página se llama Manage API Users.
3. Haga clic en Create, arriba a la derecha. EasyUC crea la cuenta de inmediato, sin otro formulario.
4. Aparece una ventana de notificación con Api key y Api secret. Copie ambos valores en su caja fuerte de contraseñas.
5. Cierre la ventana con Ok. La lista muestra entonces solo la API Key.
6. Introduzca la clave y el secreto en el sistema de terceros.

Paso a paso: consultar una interfaz

1. Seleccione Administration → Integrations & Communication → API Documentation.
2. En la lista de selección de definiciones, en la parte superior, seleccione el área, por ejemplo users o devices.
3. Despliegue el endpoint deseado y lea los parámetros, los cuerpos de ejemplo y los códigos de respuesta.
4. Preste atención al parámetro de la conexión CUCM. Muchas llamadas se refieren exactamente a un clúster.

Paso a paso: revocar una cuenta de API

1. Aclare qué sistema de terceros utiliza la clave.
2. Haga clic en Delete en la fila de la clave.
3. Confirme la consulta Are you sure?. La cuenta deja de ser válida de inmediato.

Campos y opciones

Comprobar el resultado y acotar errores

• Éxito: el sistema de terceros inicia sesión con la clave y el secreto y recibe respuestas a sus llamadas.
• Se ha perdido el secreto: elimine la cuenta y genere una nueva. Un secreto no se puede mostrar de nuevo.
• El inicio de sesión se rechaza temporalmente tras varios intentos fallidos: EasyUC ralentiza los inicios de sesión fallidos repetidos. Corrija las credenciales y espere unos minutos.
• La documentación de la API permanece vacía: solo la pueden consultar los usuarios que han iniciado sesión. Inicie sesión de nuevo y cargue la página.
• Utilice los endpoints y nombres de campo de la documentación de su propia instalación, no los de otra versión.
• El registro de auditoría conoce el tipo de actor API user. Allí puede rastrear qué se modificó mediante una cuenta de API.