API pública y aplicaciones¶
Afi Backup ofrece una API pública que puede utilizarse para administrar y supervisar las cuentas de Afi de forma automatizada. Entre los casos de uso habituales de la API pública de Afi se incluyen la supervisión automatizada del estado de las copias de seguridad y las licencias, así como el archivado de recursos.
Para conceder y administrar el acceso a la API pública, Afi utiliza el concepto de aplicación. Cada aplicación está asociada a un conjunto de permisos que define las acciones que pueden realizarse en su nombre mediante la API pública. Este artículo aborda la configuración y la administración de aplicaciones; la referencia de la API y las guías prácticas de los casos de uso habituales se encuentran en la documentación de la API.
Permisos de las aplicaciones¶
En la actualidad, se pueden conceder los siguientes permisos a las aplicaciones:
- Read configuration: acceso de lectura a la configuración y las tareas (incluidos, entre otros, los recursos y las protecciones, los estados de las tareas de copia de seguridad y los datos de informes).
- Write configuration: acceso de escritura a la configuración y las tareas (incluidos, entre otros, la asignación de protecciones a los recursos y la activación de tareas de copia de seguridad).
- Manage data: acceso a la administración de datos (incluida la eliminación programada de copias de seguridad).
- Billing access (para aplicaciones de toda la organización): acceso al estado de las licencias y al número de licencias.
Es importante señalar que estos permisos no permiten acceder a los datos reales de las copias de seguridad. Aunque una aplicación puede administrar trabajos de copia de seguridad o acceder a la configuración de un inquilino, los datos de las copias permanecen confidenciales.
Crear una aplicación¶
Las aplicaciones pueden crearse tanto para un inquilino (pestaña Service → Settings → Apps) como para toda la organización (pestaña Configuration → Apps). Las aplicaciones para toda la organización están diseñadas para acceder y administrar todos los inquilinos de la organización de Afi (cuenta de Afi) en la que están instaladas. Recomendamos configurar de forma predeterminada una aplicación para toda la organización si no necesita configurar en su cuenta de Afi un acceso granular por inquilino para la aplicación.
Para crear una aplicación, vaya a la pestaña Service → Settings → Apps o Configuration → Apps del portal de Afi y haga clic en el botón Create app. Se abrirá un cuadro de diálogo con los siguientes parámetros:
- Name: nombre único de la aplicación (por ejemplo, Test-App-Company-Name).
- Logo: (opcional) logotipo de la aplicación.
- Description: (opcional) descripción de la aplicación.
- App URL: (opcional) enlace de inicio de sesión de un servicio de terceros que se integra con Afi mediante la aplicación.
- Website: (opcional) sitio web o página de destino del servicio de terceros que se integra con Afi mediante la aplicación.
- Provider: restringe la visibilidad de la aplicación a inquilinos de un tipo concreto (por ejemplo, solo inquilinos de Microsoft 365).
- Roles: permisos concedidos a la aplicación para acceder a los inquilinos u organizaciones donde está instalada. Tenga en cuenta que los permisos no pueden modificarse después de crear la aplicación.
Una vez creada, la aplicación aparecerá en la sección Available Apps y podrá instalarse en el inquilino o la organización actual.
Generar claves de API¶
Una vez creada una aplicación, puede generar una clave para acceder a la API. Para ello, haga clic en el botón Edit situado junto a la aplicación y, a continuación, en Generate key en la sección Keys. Aparecerá un cuadro de diálogo con la clave recién generada. Cópiela y guárdela en un lugar seguro, ya que nosotros no almacenamos las claves de API, sino únicamente los hashes correspondientes. Afi permite que cada aplicación tenga hasta dos claves simultáneamente, lo que permite rotarlas o revocar aquellas que se hayan visto comprometidas.
Consulte la documentación de la API para conocer las llamadas disponibles y ver ejemplos de uso.
Instalar una aplicación¶
Para permitir que la aplicación acceda a su organización o inquilino, debe instalarla.
Una vez instalada, la aplicación se mostrará en la sección Installed Apps.
Desinstalar una aplicación¶
Para revocar el acceso de una aplicación, haga clic en el botón Manage y después en el botón Uninstall del cuadro de diálogo. Tenga en cuenta que la revocación del acceso puede tardar varias horas.