Öffentliche API und Apps¶
Afi Backup bietet eine öffentliche API, mit der Sie Afi-Konten automatisiert verwalten und überwachen können. Typische Anwendungsfälle sind die automatische Überwachung des Sicherungs- und Lizenzierungsstatus sowie das Archivieren von Ressourcen.
In Afi gewähren und verwalten Sie den Zugriff auf die öffentliche API über Apps (Anwendungen). Die Berechtigungen einer App legen fest, welche Aktionen über die öffentliche API in ihrem Namen ausgeführt werden dürfen. Dieser Artikel erklärt, wie Sie Apps einrichten und verwalten. Die API-Referenz und Anleitungen für häufige Anwendungsfälle finden Sie in der API-Dokumentation.
App-Berechtigungen¶
Apps können derzeit folgende Berechtigungen erhalten:
- Read configuration – Lesezugriff auf Konfiguration und Aufgaben, darunter Ressourcen und Schutzkonfigurationen, Status von Sicherungsaufgaben und Berichtsdaten.
- Write configuration – Schreibzugriff auf Konfiguration und Aufgaben, darunter das Zuweisen von Schutzkonfigurationen zu Ressourcen und das Auslösen von Sicherungsaufgaben.
- Manage data – Zugriff auf die Datenverwaltung, einschließlich des geplanten Löschens von Sicherungen.
- Billing access (für organisationsweite Apps) – Zugriff auf Lizenzierungsstatus und Lizenzanzahl.
Diese Berechtigungen erlauben keinen Zugriff auf die eigentlichen Sicherungsdaten. Eine App kann zwar Sicherungsaufträge verwalten oder auf Mandanteneinstellungen zugreifen, die Sicherungsdaten selbst bleiben jedoch vertraulich.
App erstellen¶
Sie können Apps für einen Mandanten auf der Registerkarte Service → Settings → Apps oder für eine ganze Organisation auf der Registerkarte Configuration → Apps erstellen. Mit organisationsweiten Apps können Sie auf alle Mandanten der Afi-Organisation (des Afi-Kontos) zugreifen, in der die App installiert ist, und diese verwalten. Wir empfehlen standardmäßig eine organisationsweite App, sofern Sie in Ihrem Afi-Konto keinen fein abgestuften Zugriff pro Mandant für die App benötigen.
Um eine App zu erstellen, öffnen Sie im Afi-Portal die Registerkarte Service → Settings → Apps oder Configuration → Apps und klicken Sie auf Create app. Ein Dialog mit folgenden Parametern wird geöffnet:
- Name – Eindeutiger Name der App, beispielsweise Test-App-Company-Name.
- Logo – Optionales Logo der App.
- Description – Optionale Beschreibung der App.
- App URL – Optionaler Anmeldelink zu einem Drittanbieterdienst, der über die App mit Afi verbunden ist.
- Website – Optionale Website oder Landingpage des Drittanbieterdienstes, der über die App mit Afi verbunden ist.
- Provider – Beschränkt die Sichtbarkeit der App auf Mandanten einer bestimmten Art, beispielsweise nur Microsoft 365-Mandanten.
- Roles – Berechtigungen, die der App für den Zugriff auf Mandanten oder Organisationen erteilt werden, in denen sie installiert ist. Berechtigungen können nach dem Erstellen der App nicht geändert werden.
Nach dem Erstellen wird die App im Abschnitt Available Apps angezeigt und kann im aktuellen Mandanten beziehungsweise in der aktuellen Organisation installiert werden.
API-Schlüssel generieren¶
Nach dem Erstellen einer App können Sie einen Schlüssel für den API-Zugriff generieren. Klicken Sie dazu neben der App auf Edit und im Abschnitt Keys auf Generate key. Ein Dialog zeigt den neu generierten Schlüssel an. Kopieren Sie den Schlüssel und bewahren Sie ihn selbst an einem sicheren Ort auf, da Afi nur die zugehörigen Hashwerte und nicht die API-Schlüssel selbst speichert. Jede App kann gleichzeitig bis zu zwei Schlüssel haben, sodass Sie Schlüssel wechseln oder kompromittierte Schlüssel widerrufen können.
Die verfügbaren API-Aufrufe und Anwendungsbeispiele finden Sie in der API-Dokumentation.
App installieren¶
Damit die App auf Ihre Organisation beziehungsweise Ihren Mandanten zugreifen kann, müssen Sie sie installieren.
Nach der Installation wird die App im Abschnitt Installed Apps angezeigt.
App deinstallieren¶
Um den Zugriff einer App zu widerrufen, klicken Sie auf Manage und anschließend im Dialog auf Uninstall. Der Widerruf kann bis zu mehreren Stunden dauern.