Sie lesen die Dokumentation zu Apigee Edge.
Sehen Sie sich die Apigee X-Dokumentation an. info
Einführung
Sie müssen Ihrem Unternehmensprofil Nutzungsbedingungen hinzufügen, bevor Sie ein Tarifpaket veröffentlichen. Die Nutzungsbedingungen befinden sich nicht im Unternehmensprofil. Geben Sie in Ihrem Unternehmensprofil den Speicherort (öffentliche URL) der Nutzungsbedingungen an.
Nachdem Sie ein Preismodell veröffentlicht haben, wird die aktuelle Version der Nutzungsbedingungen im Entwicklerportal angezeigt. Entwickler können erst dann ein Abo abschließen, wenn sie die aktuellen Nutzungsbedingungen akzeptiert haben.
Nutzungsbedingungen über die Benutzeroberfläche hinzufügen
- Rufen Sie die Seite „Organisationsprofil“ auf, wie unter Die Seite „Organisationsprofil“ beschrieben.
- Klicken Sie auf Bearbeiten.
- Klicken Sie auf der Seite „Organisationsprofil“ im Abschnitt „Nutzungsbedingungen“ auf Nutzungsbedingungen hinzufügen.
Das Dialogfeld „Neue Nutzungsbedingungen“ wird angezeigt.
- Geben Sie die folgenden Informationen ein:
Feld Beschreibung Datum des Inkrafttretens Datum, ab dem die Nutzungsbedingungen in Kraft treten. Der Standardwert ist das aktuelle Datum. Sie müssen das aktuelle oder ein zukünftiges Datum eingeben.
Version Version der Nutzungsbedingungen. Anhand der Versionsnummer können Sie verschiedene Versionen der Nutzungsbedingungen im Blick behalten.
URL URL zu den Nutzungsbedingungen.
- Klicken Sie auf Erstellen.
Die neuen Nutzungsbedingungen werden im Abschnitt „Nutzungsbedingungen“ des Organisationsprofils hinzugefügt.
- Wiederholen Sie die Schritte 3 bis 5, um weitere Nutzungsbedingungen hinzuzufügen.
- Klicken Sie auf Speichern, um die Änderungen am Organisationsprofil zu speichern.
Nutzungsbedingungen über die Benutzeroberfläche bearbeiten
Sie können die Bedingungen nicht direkt bearbeiten. Löschen Sie stattdessen die Nutzungsbedingungen, die Sie bearbeiten möchten, und fügen Sie dann einen neuen Eintrag hinzu.
Nutzungsbedingungen über die Benutzeroberfläche löschen
- Rufen Sie die Seite „Organisationsprofil“ auf, wie unter Seite „Organisationsprofil“ beschrieben.
- Klicken Sie auf der Seite „Organisationsprofil“ auf Bearbeiten.
- Bewegen Sie den Mauszeiger in der Liste der Nutzungsbedingungen auf die Nutzungsbedingungen, die Sie löschen möchten.
- Klicken Sie auf .
Nutzungsbedingungen mithilfe der API verwalten
Sie können Nutzungsbedingungen mithilfe der API wie in den folgenden Abschnitten beschrieben verwalten.
Nutzungsbedingungen über eine API hinzufügen
Fügen Sie Nutzungsbedingungen hinzu, indem Sie eine POST-Anfrage an /mint/organizations/{org_name}/tncs
senden.
Wenn Sie die Nutzungsbedingungen hinzufügen, können Sie optional Folgendes angeben:
- URL
- Begleittext (z. B. eine Beschreibung)
- Datum, ab dem die Nutzungsbedingungen in Kraft treten
- Versionsnummer
Weitere Informationen zu diesen Optionen finden Sie unter Konfigurationsattribute für Nutzungsbedingungen.
Beispiel:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \ -H "Content-Type: application/json" \ -d \ '{ "url":"www.testoperator/termsandconditions", "tncText":"Sample text for the T&C", "version":"1.1", "startDate":"2018-09-24" }' \ -u email:password
Im Folgenden finden Sie ein Beispiel für die Antwort:
{ "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ", "organization" : { … }, "startDate" : "2018-09-24 00:00:00", "tncText" : "Sample text for the T&C", "url" : "www.testoperator/termsandconditions", "version" : "1.1" }
Nutzungsbedingungen mithilfe der API aufrufen
Sie können sich bestimmte oder alle Nutzungsbedingungen für eine Organisation ansehen.
Wenn Sie bestimmte Nutzungsbedingungen aufrufen möchten, senden Sie eine GET-Anfrage an /mint/organizations/{org_name}/tncs/{tncs_id}
. {tncs_id}
ist die Kennung der jeweiligen Nutzungsbedingungen. Die ID wird in der Antwort zurückgegeben, wenn Sie die Nutzungsbedingungen erstellen. Beispiel:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \ -H "Accept: application/json" \ -u email:password
Alle Nutzungsbedingungen für die Organisation anzeigen, indem Sie eine GET-Anfrage an /mint/organizations/{org_name}/tncs
senden. Beispiel:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \ -H "Accept: application/json" \ -u email:password
Im Folgenden finden Sie ein Beispiel für die Antwort:
{
"tnc" : [ { "id" : "77193339-8d79-44a8-8af2-3593f16c158e", "organization" : { ... }, "startDate" : "2018-07-01 00:00:00", "tncText" : "Big operator text for the T&C", "url" : "www.bigoperator/termsandconditions", "version" : "1.0" }, { "id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3", "organization" : { ... }, "startDate" : "2018-09-24 00:00:00", "tncText" : "Sample text for the T&C", "url" : "www.testoperator/termsandconditions", "version" : "1.1" } ] "totalRecords" : 2 }
Akzeptieren eines Dokument mit den Nutzungsbedingungen für einen Entwickler oder ein Unternehmen, das die API verwendet
Akzeptieren Sie ein Dokument mit Nutzungsbedingungen für einen bestimmten Entwickler oder ein bestimmtes Unternehmen, indem Sie eine POST-Anfrage an eine der folgenden APIs senden:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
Dabei ist {dev_id}
die Entwickler-ID (E-Mail-Adresse), {company_id}
die Unternehmens-ID und {tncs_id}
die ID des Dokuments mit den Nutzungsbedingungen.
Beispiel:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \ -H "Content-Type: application/json" \ -d \ '{ "action":"ACCEPTED", "auditDate":"2018-10-01 00:00:00" }' \ -u email:password
Im Folgenden finden Sie ein Beispiel für die Antwort:
auditDate
auf die aktuelle Uhrzeit in UTC festgelegt.{ "action": "ACCEPTED", "auditDate": "2018-10-01 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316", ... } }
Nutzungsbedingungen ansehen, die von einem Entwickler oder Unternehmen akzeptiert wurden, das die API verwendet
Sehen Sie sich die von einem bestimmten Entwickler oder Unternehmen akzeptierten Nutzungsbedingungen an, indem Sie eine GET-Anfrage an eine der folgenden APIs senden:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
Dabei ist {dev_id}
die Entwickler-ID (E-Mail-Adresse) und {company_id}
die Unternehmens-ID.
Beispiel:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \ -H "Accept:application/json" \ -u email:password
Im Folgenden finden Sie ein Beispiel für die Antwort:
{ "developerTnc": [ { "action": "ACCEPTED", "auditDate": "2018-08-29 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "26abc14c-c628-4c38-8840-a343c8ee9437", ... } }], "totalRecords": 1 }
Nutzungsbedingungen mit der API bearbeiten
Bearbeiten Sie die Nutzungsbedingungen, indem Sie eine PUT-Anfrage an /mint/organizations/{org_named}/tncs/{tncs_id}
senden. Dabei ist {tncs_id}
die Kennung der Nutzungsbedingungen. Geben Sie beim Aktualisieren im Anfragetext die aktualisierten Einstellungen und die Kennzeichnung der Nutzungsbedingungen an. Mit der folgenden Anfrage wird beispielsweise die Versionsnummer für die Nutzungsbedingungen bearbeitet. Die aktualisierte Property ist im Beispiel hervorgehoben:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \ -H "Content-Type: application/json" \ -d { "id":"6803d70a-18cc-40c8-b250-675c5e8a75c", "version":"1.2" }' \ -u email:password
Im Folgenden finden Sie ein Beispiel für die Antwort:
{ "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9", "organization" : { "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], …" }, "startDate" : "2018-09-24 00:00:00", "tncText" : "Sample text for the T&C", "url" : "www.testoperator/termsandconditions", "version" : "1.2" }
Nutzungsbedingungen mit der API löschen
Löschen Sie Nutzungsbedingungen, indem Sie eine DELETE-Anfrage an /mint/organizations/{org_name}/tncs/{tncs_id}
senden, wobei {tncs_id}
die Identifizierung der Nutzungsbedingungen ist. Beispiel:
curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \ -H "Accept: application/json" \ -u email:password
Konfigurationseigenschaften der Nutzungsbedingungen für die API
In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die mithilfe der API für Nutzungsbedingungen festgelegt werden können.
Name | Beschreibung | Standard | Erforderlich? |
---|---|---|---|
url |
URL der Nutzungsbedingungen. |
– | Nein |
tncText |
Text (z. B. eine kurze Beschreibung) für die Nutzungsbedingungen. |
– | Nein |
version |
Version der Nutzungsbedingungen. Anhand der Versionsnummer können Sie verschiedene Versionen der Nutzungsbedingungen im Blick behalten. |
– | Ja |
startDate |
Datum, ab dem die Nutzungsbedingungen in Kraft treten. |
– | Ja |
organization |
Organisation für die Nutzungsbedingungen. |
– | Nein |
Nächste Schritte
Informationen zum Hinzufügen unterstützter Währungen zu denjenigen, die ursprünglich für Ihre Organisation eingerichtet wurden, finden Sie unter Unterstützte Währungen verwalten.