Nutzungsbedingungen verwalten

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation
weitere Informationen

Einführung

Sie müssen Ihrem Organisationsprofil Nutzungsbedingungen hinzufügen, bevor Sie einen Preisplan veröffentlichen. Die Nutzungsbedingungen befinden sich außerhalb des Organisationsprofils. Im Profil Ihrer Organisation geben Sie den Speicherort (öffentliche URL) der Nutzungsbedingungen an.

Nachdem Sie einen Preisplan veröffentlicht haben, wird die aktuelle Version der Nutzungsbedingungen im Entwicklerportal angezeigt. Entwickler können erst dann einen Tarif kaufen, wenn sie die aktuellen Nutzungsbedingungen akzeptiert haben.

Nutzungsbedingungen über die Benutzeroberfläche hinzufügen

  1. Rufen Sie die Seite "Organisationsprofil" auf, wie unter Informationen zur Seite "Organisationsprofil" beschrieben.
  2. Klicken Sie auf Bearbeiten.
  3. Klicken Sie auf der Seite „Organisationsprofil“ im Abschnitt „Nutzungsbedingungen“ auf Nutzungsbedingungen hinzufügen.

    Das Dialogfeld „Neue Nutzungsbedingungen“ wird angezeigt.

  4. Geben Sie die folgenden Informationen ein:
    Feld Beschreibung
    Datum des Inkrafttretens

    Datum des Inkrafttretens der Nutzungsbedingungen. Standardmäßig ist das aktuelle Datum ausgewählt. Geben Sie das aktuelle oder ein zukünftige Datum ein.

    Version

    Version der Nutzungsbedingungen Anhand der Versionsnummer können Sie verschiedene Versionen der Nutzungsbedingungen verfolgen.

    URL

    URL der Nutzungsbedingungen.

  5. Klicken Sie auf Erstellen.

    Die neuen Nutzungsbedingungen werden im Bereich „Nutzungsbedingungen“ auf der Seite „Organisationsprofil“ hinzugefügt.

  6. Wiederholen Sie die Schritte 3 bis 5, um weitere Bedingungen hinzuzufügen.
  7. Klicken Sie auf Speichern, um die Änderungen am Organisationsprofil zu speichern.

Bedingungen über die Benutzeroberfläche bearbeiten

Sie können die Nutzungsbedingungen nicht direkt bearbeiten. Löschen Sie stattdessen die Nutzungsbedingungen, die Sie bearbeiten möchten, und fügen Sie dann einen neuen Eintrag hinzu.

Löschen von Nutzungsbedingungen über die Benutzeroberfläche

  1. Rufen Sie die Seite "Organisationsprofil" auf, wie unter Informationen zur Seite "Organisationsprofil" beschrieben.
  2. Klicken Sie auf der Seite „Organisationsprofil“ auf Bearbeiten.
  3. Bewegen Sie den Mauszeiger in der Liste der Nutzungsbedingungen auf die Nutzungsbedingungen, die Sie löschen möchten.
  4. Klicken Sie auf .

Nutzungsbedingungen mithilfe der API verwalten

Verwalten Sie Nutzungsbedingungen mithilfe der API, wie in den folgenden Abschnitten beschrieben.

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 des Inkrafttretens der Nutzungsbedingungen
  • Versionsnummer

Weitere Informationen zu diesen Optionen finden Sie unter Eigenschaften der Konfiguration der 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 ansehen

Sie können sich bestimmte Nutzungsbedingungen oder alle Nutzungsbedingungen einer Organisation ansehen.

Sie können sich bestimmte Nutzungsbedingungen ansehen, indem Sie eine GET-Anfrage an /mint/organizations/{org_name}/tncs/{tncs_id} senden, wobei {tncs_id} die Identifizierung der jeweiligen Nutzungsbedingungen ist (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

Sehen Sie sich alle Nutzungsbedingungen für die Organisation an, 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
}

Nutzungsbedingungen für einen Entwickler oder ein Unternehmen mithilfe der API akzeptieren

Akzeptieren Sie ein Dokument mit den 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:

Hinweis: In der Antwortnutzlast ist auditDate auf die aktuelle Zeit in UTC festgelegt.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

Nutzungsbedingungen aufrufen, die von einem Entwickler oder Unternehmen über die API akzeptiert wurden

Sie können sich die Nutzungsbedingungen ansehen, die von einem bestimmten Entwickler oder Unternehmen akzeptiert wurden, 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 mithilfe der API bearbeiten

Bearbeiten Sie die Nutzungsbedingungen, indem Sie eine PUT-Anfrage an /mint/organizations/{org_named}/tncs/{tncs_id} senden, wobei {tncs_id} die Identifikation der Nutzungsbedingungen ist. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Einstellungen und die Identifizierung der Nutzungsbedingungen angeben. Mit der folgenden Anfrage wird beispielsweise die Versionsnummer der Nutzungsbedingungen geändert (das aktualisierte Attribut 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 über die 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

Eigenschaften der Konfiguration 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) der Nutzungsbedingungen.

Nein
version

Version der Nutzungsbedingungen. Anhand der Versionsnummer finden Sie verschiedene Versionen der Nutzungsbedingungen.

Ja
startDate

Datum des Inkrafttretens der Nutzungsbedingungen.

Ja
organization

Organisation der Nutzungsbedingungen.

Nein

Nächste Schritte

Unter Unterstützte Währungen verwalten erfahren Sie, wie Sie unterstützte Währungen zusätzlich zu den ursprünglich für Ihre Organisation festgelegten Währungen hinzufügen.