Regelsatzbeispiel
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsRegelsatzbeispiel mit unterschiedlichem Zugriff für unterschiedliche API-Verbrauchertypen
In diesem Beispielszenario verwenden wir die Campaign-API. Die Campaign-API verfügt über die folgenden API-Operationen:
Die GET /campaign-Operationen werden von einem Webshop verwendet, um aktive Kampagnen über die API abzurufen. Der Webshop muss nur die aktiven Kampagnen abrufen und sie den Benutzern anzeigen. Daher sollte der Webshop keinen Zugriff haben, um neue Kampagnen zu erstellen (POST /campaign/create) oder vorhandene Kampagnen zu aktualisieren (PUT /campaign/update).
Für die Verwaltung aller Kampagnen gibt es eine separate Web-Benutzeroberfläche. Die Verwaltungswebsite muss auf alle API-Operationen der Kampagnen-API zugreifen können.
Empfohlene Methode zum Einrichten von Regelsätzen für verschiedene API-Verbrauchergruppen
In solchen Anwendungsfällen empfiehlt es sich, für jede API-Verbrauchergruppe pro API eindeutige Regelsätze einzurichten.
Dies ist ein Beispiel für einen Regelsatz für den Webshop, der Zugriff auf eine API-Operation gewährt und eine Liste von Kampagnen zurückgibt:
Mit dem mit dem Regelsatz verknüpften API-Schlüssel „Webshop/Kampagnenliste/Entwicklungs-API-Schlüssel“ hat der Webshop nun Zugriff auf die Operation GET /api/campaign/v1, um die Liste der aktiven Kampagnen abzurufen, aber nicht auf andere API-Operationen.
Wenn andere neue API-Clients eine Liste aktiver Kampagnen benötigen, können Sie ganz einfach einen separaten API-Schlüssel erstellen, beispielsweise für andere Websites, und diese API-Schlüssel mit diesem Regelsatz verknüpfen.
Der nächste Artikel istBeispiel für einen Regelsatz für den vollständigen Zugriff auf die Campaign-API
Verwandte ArtikelAPI-SchlüsselZugriff auf die Verwaltungs-API mit Swagger UIEinführung in RegelsätzeBeispiel für ein Szenario mit grundlegenden RegelsätzenBeispiel für einen Regelsatz für den vollständigen Zugriff auf die Campaign-API