API publique et applications¶

Afi Backup fournit une API publique qui peut être utilisée pour gérer et surveiller automatiquement les comptes Afi. Les cas d’utilisation courants de l’API publique Afi incluent la surveillance automatisée de l’état des sauvegardes et des licences, ainsi que l’archivage des ressources.

Pour accorder et gérer l’accès à l’API publique, Afi utilise le concept d’application. Chaque application est associée à un ensemble d’autorisations qui définit les actions pouvant être effectuées au nom de l’application via l’API publique. Cet article traite de la configuration et de la gestion des applications, tandis que la référence de l’API et les guides pratiques pour les cas d’utilisation courants se trouvent dans la documentation de l’API.

Autorisations des applications¶

Actuellement, les applications peuvent recevoir les autorisations suivantes :

Read configuration - Accès en lecture à la configuration et aux tâches (y compris, sans s’y limiter, les ressources et protections, les états des tâches de sauvegarde et les données de rapport).
Write configuration - Accès en écriture à la configuration et aux tâches (y compris, sans s’y limiter, l’attribution de protections aux ressources et le déclenchement de tâches de sauvegarde).
Manage data - Accès à la gestion des données (y compris la suppression planifiée des sauvegardes).
Billing access (pour les applications à l’échelle de l’organisation) - Accès à l’état des licences et au nombre de licences.

Il est important de noter que ces autorisations ne permettent pas d’accéder aux données de sauvegarde elles-mêmes. Bien qu’une application puisse gérer des tâches de sauvegarde ou accéder aux paramètres d’un locataire, les données de sauvegarde restent confidentielles.

Créer une application¶

Les applications peuvent être créées à la fois au niveau du locataire (onglet Service → Settings → Apps) et de l’organisation entière (onglet Configuration → Apps). Les applications à l’échelle de l’organisation sont conçues pour accéder à tous les locataires d’une organisation Afi (compte Afi) où elles sont installées et les gérer. Nous vous conseillons de configurer par défaut une application à l’échelle de l’organisation si vous n’avez pas besoin de configurer un accès granulaire par locataire pour votre application dans votre compte Afi.

Pour créer une application, accédez à l’onglet Service → Settings → Apps ou à l’onglet Configuration → Apps dans le portail Afi, puis cliquez sur le bouton Create app. Une boîte de dialogue contenant les paramètres suivants s’ouvre :

Name - Nom unique de l’application (par exemple, Test-App-Company-Name).
Logo - (facultatif) Logo de l’application.
Description - (facultatif) Description de l’application.
App URL - (facultatif) Lien de connexion vers un service tiers qui s’intègre à Afi via l’application.
Website - (facultatif) Site web ou page de destination du service tiers qui s’intègre à Afi via l’application.
Provider - Restreint la visibilité de l’application aux locataires d’un type spécifié (par exemple, uniquement les locataires Microsoft 365)
Roles - Autorisations accordées à l’application pour accéder aux locataires ou aux organisations où elle est installée. Veuillez noter que les autorisations ne peuvent pas être modifiées après la création de l’application.

Après la création d’une application, elle apparaît dans la section Available Apps et peut être installée dans le locataire/l’organisation actuel.

Générer des clés d’API¶

Une fois une application créée, vous pouvez générer une clé pour l’accès à l’API. Pour cela, cliquez sur le bouton Edit à côté de l’application, puis cliquez sur Generate key dans la section Keys. Une boîte de dialogue affichant la clé nouvellement générée s’ouvre. Veuillez copier et enregistrer la clé dans un emplacement sécurisé, car nous ne stockons pas les clés d’API de notre côté, seulement les valeurs de hachage correspondantes. Afi permet à chaque application d’avoir jusqu’à deux clés simultanément, ce qui vous permet de faire tourner les clés ou de révoquer celles qui sont compromises.

Veuillez consulter la documentation de l’API pour connaître les appels d’API disponibles et obtenir des exemples d’utilisation.

Installer une application¶

Pour autoriser l’application à accéder à votre organisation/locataire, vous devez l’installer.

Une fois l’application installée, elle s’affiche dans la section Installed Apps.

Désinstaller une application¶

Pour révoquer l’accès d’une application, cliquez sur le bouton Manage, puis sur le bouton Uninstall dans la boîte de dialogue. Veuillez noter que la révocation de l’accès peut prendre plusieurs heures.