Grundlegende Anweisungen zur Verwaltungs-API
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsMit der Management-API können Frends über eine API-Schnittstelle verwaltet werden. Damit können Aktionen wie das Bearbeiten von Umgebungsvariablen oder das Bereitstellen von Prozessen automatisiert werden.
Hinweis: Die Management-API-Autorisierung ist von der normalen Autorisierung getrennt und die Vorgänge werden derzeit immer mit vollständigen Administratorrechten ausgeführt. Das Anzeigen der Swagger-Benutzeroberfläche ist allen Benutzern mit Zugriff auf die Benutzeroberfläche gestattet, der Zugriff auf die API-Methoden in der Swagger-Benutzeroberfläche ist jedoch nur Benutzern mit einer Rolle gestattet, die über die Regel AllowAction ManagementApi.Admin imRollenkonfiguration.
Sie können alle unterstützten API-Operationen in der Swagger-Benutzeroberfläche sehen. Die Swagger-URL wird erstellt, indem der Frends-URL das Suffix /swagger hinzugefügt wird, zum Beispiel:
https://example.frendsapp.com/swagger
Weitere Informationen zur Verwendung der Swagger-Benutzeroberfläche finden SieHier.
Allgemeine Informationen und Richtlinien
Die API ist für eine RESTful-Verwendung konzipiert, wobei Frends-Elemente so angegeben werden, dass auf sie über ihre IDs zugegriffen werden kann. Einige Antworten enthalten Links, die dabei helfen, weitere Anfragen für die in der Antwort enthaltenen Elemente zu stellen. Listen verwenden Paging- oder Fortsetzungstoken, wenn sich die Daten schnell ändern, z. B. Prozessinstanzen. In diesen Fällen müssen Sie das Fortsetzungstoken verwenden, um eine konsistente Erfahrung beim Aufzählen der Liste zu erzielen.
Derzeit gibt es keine Ratenbegrenzung, Sie sollten die API jedoch nicht mit Anfragen spammen, da Sie sonst das Risiko eingehen, dass sie deaktiviert wird.
Authentifizierung
Die Management-API verwendet die Bearer-Token-Authentifizierung. Das Bearer-Token wird vom Authentifizierungsserver für Sie erstellt und muss separat hinzugefügt werden, indem Sie Kontakt aufnehmenUnterstützung durch Freunde. Derzeit wird nur Azure Active Directory (AAD) unterstützt.
Hier ist einFührungzum Erstellen einer Azure Active Directory (AAD)-Anwendung für die Verwaltungs-API und wie Sie diese Informationen dem Frends-Support bereitstellen.
Wenn ein Benutzer Ihre Anwendung (Client) beim Authentifizierungsserver authentifiziert, generiert der Server ein Token für Sie.
Für das externe API-Tool wie Postman ist eine Bearer-Token-Authentifizierung erforderlich.
Um ein Bearer-Token zu erhalten, müssen Sie eine Anfrage mit den folgenden Parametern erstellen:
Für die Bearer-Token-Authentifizierung benötigen Sie die folgende Anfrage
POST-URL
https://login.microsoftonline.com/<AAD-Mandant>.onmicrosoft.com/oauth2/token
KÖRPER
Berechtigungstyp:Client-Anmeldeinformationen
Client-ID:<AAD-Anwendungs-ID>
Client-Geheimnis:<Geheimer AAD-Anwendungsclient>
Ressource: api://<AAD-Anwendungs-ID>
Die zurückgegebene Antwort enthält das Bearer-Token, das entweder in der Swagger-Benutzeroberfläche oder für Anforderungen an die Benutzeroberfläche verwendet wird, indem es als Header bereitgestellt wird:
Autorisierung: Bearer <Bearer-Token>
Beispielverwendung der Management-API mit Postman
Das Postman-Tool kann zur Automatisierung von API-Vorgängen über die API-Schnittstelle und zum Testen verwendet werden.
Um die Swagger-Spezifikation in eine Postman-Sammlung zu konvertieren, verwenden Sie dies
Führung.
In der Swagger-UI-Oberfläche können Sie hier die Dokumentations-URL sehen:
Nachdem Sie die Swagger-Dokumentation in die Postman-Sammlung konvertiert haben, sollten Sie ungefähr Folgendes sehen.
Wählen Sie auf der Hauptebene der Postman-Sammlung den Autorisierungstyp „Bearer Token“ aus:
Das Token muss bei der ersten Anfrage der Sammlung generiert werden.
Sie müssen einen Post Request erstellen und die zuvor erwähnten Authentifizierungsparameter verwenden
Das Bearer-Token wird aus dem Text der Antwortnachricht entnommen und in allen Postman-Anfragen verwendet.
Beispiel: API-Regelsatz erstellen
Verwandte ArtikelAPI-TriggerAuthentifizierung zum Anzeigen der API-SpezifikationenEinführung in die API-Authentifizierung mit FrendsManagement-API v.0.9 EndpunkteÄnderungen an Frends API 1.0