Nutzungsbedingungen verwalten

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

Einführung

Sie müssen Ihrem Organisationsprofil Nutzungsbedingungen hinzufügen, bevor Sie einen Tarif veröffentlichen. Die Nutzungsbedingungen befinden sich außerhalb des Organisations profils. In Ihrem Organisationsprofil geben Sie den Speicherort (öffentliche URL) der Nutzungsbedingungen an.

Nachdem Sie einen Tarif veröffentlicht haben, wird die aktuelle Version der Nutzungsbedingungen im Entwicklerportal angezeigt. Entwickler können einen Tarif nur erwerben, nachdem sie die aktuellen Nutzungsbedingungen akzeptiert haben.

Nutzungsbedingungen über die UI hinzufügen

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

    Das Dialogfeld „Neue Nutzungsbedingungen“ wird angezeigt.

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

    Datum, an dem die Nutzungsbedingungen in Kraft treten. Standardmäßig ist das aktuelle Datum festgelegt. Sie müssen das aktuelle Datum oder ein zukünftiges Datum eingeben.
    Version

    Version der Nutzungsbedingungen. Mit der Versionsnummer können Sie verschiedene Versionen der Nutzungsbedingungen nachverfolgen.
    URL

    URL der Nutzungsbedingungen.
  5. Klicken Sie auf Erstellen.

    Die neuen Nutzungsbedingungen werden dem Abschnitt „Nutzungsbedingungen“ der Seite „Organisationsprofil“ hinzugefügt.

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

Nutzungsbedingungen über die UI bearbeiten

Sie können die Nutzungsbedingungen nicht direkt bearbeiten. Stattdessen müssen Sie die Nutzungsbedingungen löschen, die Sie bearbeiten möchten, und dann einen neuen Eintrag für die Nutzungsbedingungen hinzufügen.

Nutzungsbedingungen über die UI löschen

  1. Rufen Sie die Seite „Organisationsprofil“ auf, wie unter 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 über die API verwalten

Verwalten Sie Nutzungsbedingungen über die 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
  • Begleitender Text (z. B. eine Beschreibung)
  • Datum, an dem die Nutzungsbedingungen in Kraft treten
  • Versionsnummer

Weitere Informationen zu diesen Optionen finden Sie unter Konfigurationseigenschaften 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 über die API ansehen

Sie können bestimmte Nutzungsbedingungen oder alle Nutzungsbedingungen für eine Organisation ansehen.

Rufen Sie bestimmte Nutzungsbedingungen auf, indem Sie eine GET-Anfrage an /mint/organizations/{org_name}/tncs/{tncs_id} senden. Dabei ist {tncs_id} die ID 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

Rufen Sie alle Nutzungsbedingungen für die Organisation auf, 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 über die API akzeptieren

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 Dokument-ID der 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 wird 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",
      ...
  }
}

Von einem Entwickler oder Unternehmen akzeptierte Nutzungsbedingungen über die API ansehen

Rufen Sie die von einem bestimmten Entwickler oder Unternehmen akzeptierten Nutzungsbedingungen auf, 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 über die API bearbeiten

Bearbeiten Sie Nutzungsbedingungen, indem Sie eine PUT-Anfrage an /mint/organizations/{org_named}/tncs/{tncs_id} senden. Dabei ist {tncs_id} die ID der Nutzungsbedingungen. Wenn Sie die Aktualisierung vornehmen, müssen Sie im Anfragetext die aktualisierten Einstellungen und die ID der Nutzungsbedingungen angeben. Mit der folgenden Anfrage wird beispielsweise die Versionsnummer für die Nutzungsbedingungen bearbeitet. Die aktualisierte Eigenschaft 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. Dabei ist {tncs_id} die ID der Nutzungsbedingungen. 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 für Nutzungsbedingungen für die API

In der folgenden Tabelle sind die Konfigurationseigenschaften zusammengefasst, die über die 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. Mit der Versionsnummer können Sie verschiedene Versionen der Nutzungsbedingungen nachverfolgen.

 – Ja
startDate

Datum, an dem die Nutzungsbedingungen in Kraft treten.

 – Ja
organization

Organisation für die Nutzungsbedingungen.

 – Nein

Nächste Schritte

Informationen zum Hinzinzufügen unterstützter Währungen zu den Währungen, die ursprünglich für Ihre Organisation eingerichtet wurden, finden Sie unter Unterstützte Währungen verwalten.