Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Wenn Sie mehr Kontrolle über die Unternehmen und Entwickler haben möchten, die an Ihrem monetarisierten API-Programm teilnehmen, z. B. interne Unternehmen und Entwickler zu Testzwecken erstellen, können Sie Unternehmen und Entwickler manuell über die Verwaltungsoberfläche und die API erstellen.
Ob Sie Unternehmen und Entwickler manuell erstellen müssen, ist eine Hauptüberlegung, ob die Entwickler Anmeldedaten benötigen, um sich in der Verwaltungs-UI anzumelden, Anmeldedaten in Aufrufen an die Edge-Management-API zu senden oder sich in einem Entwicklerportal anzumelden.
- Wenn Ihre Monetarisierungsentwickler Anmeldedaten für den Zugriff auf die Edge-Benutzeroberfläche oder -API benötigen, müssen sie zuerst ein eigenes Apigee-Administratorkonto haben.
- Wenn Sie einfach Testentwickler erstellen möchten, die keine Anmeldedaten benötigen (z. B. wenn Sie API-Aufrufe mit fiktiven Testentwicklern ausführen möchten), sind keine Apigee-Konten erforderlich.
App-Entwickler mithilfe der Benutzeroberfläche verwalten
Erstellen, verwalten und aktivieren Sie App-Entwickler mithilfe der Edge-Benutzeroberfläche, wie unter App-Entwickler verwalten beschrieben. Nachdem App-Entwickler erstellt wurden, können Sie sie Unternehmen hinzufügen, wie in den folgenden Abschnitten beschrieben.
Unternehmen über die Benutzeroberfläche verwalten
Erstellen, verwalten und aktivieren Sie Unternehmen wie in den folgenden Abschnitten beschrieben.
Seite „Unternehmen“
Rufen Sie wie unten beschrieben die Seite „Unternehmen“ auf.
Edge
So greifen Sie über die Edge-Benutzeroberfläche auf die Seite „Unternehmen“ zu:
- Melden Sie sich unter apigee.com/edge an.
- Wählen Sie in der linken Navigationsleiste Veröffentlichen > Monetarisierung > Unternehmen aus.
Die Seite "Unternehmen" wird angezeigt.
Wie in der Abbildung hervorgehoben, können Sie auf der Seite „Unternehmen“ Folgendes tun:
- Zusammenfassungsinformationen für alle Unternehmen abrufen, einschließlich Unternehmensname, Registrierungs-ID, Anzahl der registrierten Apps und API-Schlüssel, Abrechnungstyp, Anzahl der dem Unternehmen zugewiesenen Entwickler und Status
- Unternehmen hinzufügen
- Unternehmen aktivieren oder deaktivieren
- Unternehmen bearbeiten
- Unternehmen löschen
- In der Unternehmensliste suchen
Classic Edge (Private Cloud)
So greifen Sie über die Classic Edge-Benutzeroberfläche auf die Seite „Unternehmen“ zu:
- Melden Sie sich bei
http://ms-ip:9000
an, wobei ms-ip die IP-Adresse oder der DNS-Name des Knotens des Verwaltungsservers ist. - Wählen Sie in der oberen Navigationsleiste Veröffentlichen > Unternehmen aus.
Die Seite "Unternehmen" wird angezeigt.
- Aktuelle Liste der Unternehmen ansehen
- Unternehmen verwalten. Insbesondere können Sie ein Unternehmen hinzufügen, aktivieren, bearbeiten und löschen.
- Verbundenes Entwicklerportal ansehen (nur Drupal 7)
Unternehmen hinzufügen
So fügen Sie ein Unternehmen hinzu:
- Rufen Sie die Seite „Unternehmen“ auf.
- Klicken Sie auf + Unternehmen.
- Geben Sie die Informationen zum Unternehmen ein.
Pflichtfelder sind:
- Name des Unternehmens
- Administrator (der Nutzer, der der primäre Administrator des Unternehmens ist)
- Abrechnungsart
Abhängig von der Abrechnungskonfiguration für die Monetarisierung kann der Abrechnungstyp standardmäßig
PREPAID
oderPOSTPAID
lauten. Weitere Informationen finden Sie unter Prepaid- und Postpaid-Abrechnungstypen mithilfe der API konfigurieren. - Fügen Sie dem Unternehmen einen oder mehrere Entwickler hinzu.
- Geben Sie im Abschnitt „Entwickler“ einen String in das Feld Entwickler hinzufügen ein, um die Liste der Entwickler aufzurufen, die dem String entsprechen.
- Wählen Sie einen Entwickler aus der Drop-down-Liste aus.
- Wiederholen Sie diese Schritte, um weitere Entwickler zum Unternehmen hinzuzufügen.
- Fügen Sie ein oder mehrere benutzerdefinierte Attribute hinzu.
- Klicken Sie im Bereich „Benutzerdefinierte Attribute“ auf + Neu.
- Geben Sie den Namen und den Wert des benutzerdefinierten Attributs ein.
- Wiederholen Sie diese Schritte, um weitere benutzerdefinierte Attribute für das Unternehmen hinzuzufügen.
- Klicken Sie auf Unternehmen erstellen.
Aktivieren und Deaktivieren eines Unternehmens
So aktivieren und deaktivieren Sie ein Unternehmen:
- Rufen Sie die Seite „Unternehmen“ auf.
- Platzieren Sie den Cursor über dem Unternehmen, das Sie im Aktionsmenü aktivieren und aktivieren möchten.
Deaktivieren Sie die Ein-/Aus-Schaltfläche, um das Unternehmen zu deaktivieren.
Unternehmen bearbeiten
So bearbeiten Sie ein Unternehmen:
- Rufen Sie die Seite „Unternehmen“ auf.
- Platzieren Sie den Mauszeiger auf dem Unternehmen, das Sie bearbeiten möchten, und klicken Sie im Aktionsmenü auf .
- Aktualisieren Sie die Unternehmensinformationen, falls erforderlich.
- Klicken Sie auf Unternehmen aktualisieren, um die Änderungen zu speichern.
Unternehmen löschen
So löschen Sie ein Unternehmen:
- Rufen Sie die Seite „Unternehmen“ auf.
- Platzieren Sie den Mauszeiger auf dem Unternehmen, das Sie löschen möchten, und klicken Sie im Aktionsmenü auf .
- Klicken Sie auf Delete, um den Löschvorgang zu bestätigen.
Unternehmen und Entwickler mithilfe der API verwalten
Die Verwendung der API zum Verwalten von Unternehmen und Entwicklern wird in den folgenden Abschnitten beschrieben.
Unternehmen und Entwickler mithilfe der API erstellen und aktualisieren
Informationen zum Verwalten von Unternehmen und Entwicklern mit der API Edge Management API finden Sie in den folgenden API-Abschnitten:
- Unternehmen erstellen
- Entwickler erstellen
Hinweis: Sie können beim Erstellen eines Entwicklers Monetarisierungsinformationen konfigurieren, indem Sie benutzerdefinierte Attribute übergeben. - Entwickler des Unternehmens hinzufügen oder aktualisieren
Hinweis: Optional können Sie dem Entwickler eine Rolle zuweisen. Dies ist aber nicht erforderlich. Eine Liste der Entwicklerrollen finden Sie unter Entwicklerrollen abrufen. - Listen Sie die Monetarisierungskonfiguration für alle Entwickler oder für einen einzelnen Entwickler auf.
Hinweis: Definieren Sie die Monetarisierungsinformationen, indem Sie beim Erstellen oder Aktualisieren eines Entwicklers benutzerdefinierte Attribute übergeben. Sie können die benutzerdefinierten Attribute für die Monetarisierung aufrufen, die mit der Standard-API (ohne Monetarisierung) festgelegt wurden, um alle Entwickler oder einzelne Entwickler aufzulisten.
Entwicklerrollen mithilfe der API verwalten
Sie können Rollen mithilfe von Monetarisierungs-APIs erstellen. Auf diese Weise können Sie Rollen für Ihre Partner festlegen. Sie können beispielsweise Administrator- und Anwendungsentwicklerrollen für einen Partner festlegen. Diese Rollen können dann bestimmten Partnermitarbeitern zugewiesen werden.
Entwicklerrolle erstellen
Senden Sie zum Erstellen einer Entwicklerrolle eine POST-Anfrage an organizations/{org_name}/developer-roles
. Wenn Sie die Anfrage stellen, müssen Sie im Anfragetext den Namen und die Beschreibung der Rolle sowie die Identifikation der Organisation angeben. Beispiel:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "appDeveloper", "description": "App Developer", "organization": { "id": "{org_name}" } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \ -u email:password
Entwicklerrollen abrufen
Senden Sie eine GET-Anfrage an organizations/{org_id}/developer-roles, um Entwicklerrollen abzurufen. Beispiel:
$ curl -H "Accept:application/json" -X GET \ "https:// api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developer-roles" \ -u email:password
Die Antwort sollte in etwa so aussehen (nur ein Teil der Antwort wird angezeigt):
{ "description" : "App Developer", "id" : "appdeveloper", "name" : "appDeveloper", "organization" : { ... } }
Konfigurationseinstellungen der Entwicklerrolle für die API
Die folgenden Konfigurationsoptionen für Entwicklerrollen sind in der API verfügbar:
Name | Beschreibung | Standard | Erforderlich? |
---|---|---|---|
name |
Der Name der Entwicklerrolle. |
– | Ja |
description |
Eine Beschreibung der Entwicklerrolle. |
– | Ja |
Steuersatz für einen Entwickler über die API abrufen
Sie können den aktuellen Steuersatz für einen Entwickler abrufen, indem Sie eine GET-Anfrage an organizations/{org_name}/tax-engine
senden. Wenn Sie die Anfrage stellen, müssen Sie die Identifikation des Entwicklers als Abfrageparameter angeben. Beispiel:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tax-engine?developerId=dev7@myorg.com" \ -u email:password
Die Antwort sollte in etwa so aussehen:
0.09
Andere entwicklerspezifische Aufgaben mithilfe der API ausführen
Viele der mit der Monetarisierung verbundenen Aufgaben, die Sie für eine Organisation ausführen können, z. B. das Erstellen von Preisplänen oder Benachrichtigungsbedingungen, können Sie auch für einen einzelnen Entwickler ausführen. Du kannst beispielsweise ein Bankkonto für einen bestimmten Entwickler erstellen oder einen Umsatzbericht für einen bestimmten Entwickler erstellen.
In der folgenden Tabelle sind entwicklerspezifische Aufgaben aufgeführt, die Sie mit Monetarisierungs-APIs ausführen können. Die Tabelle enthält auch eine Liste mit detaillierten Anleitungen zur Ausführung dieser Aufgaben.
Aufgabe | Wo finde ich die Anleitung? |
---|---|
Nutzungsbedingungen ansehen, die von einem Entwickler akzeptiert wurden | |
Von einem Entwickler akzeptierte API-Pakete ansehen |
Von einem Entwickler oder Unternehmen akzeptierte API-Produktpakete mithilfe der API ansehen |
Tarifplan für Entwickler erstellen | |
Für Entwickler verfügbare Preispläne ansehen | |
Für einen bestimmten Entwickler verfügbare Preispläne mit einem bestimmten Produkt ansehen |
Über die API akzeptierten Tarif für einen Entwickler aufrufen, der ein API-Produkt enthält |
Nur akzeptierte Preispläne für Entwickler ansehen |
Über die API alle von einem Entwickler akzeptierten Preispläne ansehen |
Guthaben an einen Entwickler ausstellen | |
Kreditlimit für Entwickler festlegen | |
Kreditlimit für Entwickler ansehen | |
Guthaben auf das Prepaidguthaben eines Entwicklers aufladen | |
Prepaidguthaben eines Entwicklers ansehen | |
Benachrichtigungsbedingung für einen Entwickler einrichten | |
Berichtsdefinitionen für einen Entwickler erstellen und aufrufen |