Öffentliche API und Apps¶

Afi Backup stellt eine öffentliche API zur automatisierten Verwaltung und Überwachung von Afi-Konten bereit. Typische Anwendungsfälle sind die automatisierte Überwachung des Sicherungs- und Lizenzierungsstatus sowie die Ressourcenarchivierung.

Für die Gewährung und Verwaltung des Zugriffs auf die öffentliche API verwendet Afi Anwendungen. Jede Anwendung ist mit einem Berechtigungssatz verknüpft, der festlegt, welche Aktionen über die öffentliche API in ihrem Namen ausgeführt werden dürfen. Dieser Artikel behandelt die Einrichtung und Verwaltung von Anwendungen. Die API-Referenz und Anleitungen für häufige Anwendungsfälle finden Sie in der API-Dokumentation.

Anwendungsberechtigungen¶

Anwendungen 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 Ressourcenschutzkonfigurationen 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 Anwendungen) – Zugriff auf Lizenzierungsstatus und Lizenzanzahl.

Diese Berechtigungen erlauben keinen Zugriff auf die eigentlichen Sicherungsdaten. Eine Anwendung kann zwar Sicherungsaufträge verwalten oder auf Mandanteneinstellungen zugreifen, die Sicherungsdaten selbst bleiben jedoch vertraulich.

App erstellen¶

Apps können sowohl für einen Mandanten auf der Registerkarte Service → Settings → Apps als auch organisationsweit auf der Registerkarte Configuration → Apps erstellt werden. Organisationsweite Apps greifen auf alle Mandanten der Afi-Organisation (des Afi-Kontos) zu, in der sie installiert sind, und verwalten diese. Wenn Sie für Ihre Anwendung keinen granularen mandantenspezifischen Zugriff konfigurieren müssen, empfehlen wir standardmäßig eine organisationsweite Anwendung.

Um eine App zu erstellen, öffnen Sie im Afi-Portal die Registerkarte Service → Settings → Apps oder Configuration → Apps und klicken 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 in Afi integriert ist.
Website – Optionale Website oder Landingpage des über die App in Afi integrierten Drittanbieterdienstes.
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 und speichern Sie ihn an einem sicheren Ort. Afi speichert nicht die API-Schlüssel selbst, sondern nur die zugehörigen Hashwerte. Jede App kann gleichzeitig bis zu zwei Schlüssel haben, sodass Sie Schlüssel rotieren 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 mehrere Stunden dauern.