Nutzungsbedingungen verwalten

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation.
Weitere Informationen

Einführung

Sie müssen Ihrem Organisationsprofil Nutzungsbedingungen hinzufügen, bevor Sie einen Preisplan veröffentlichen können. Die Nutzungsbedingungen befinden sich außerhalb der Organisation. zu erstellen. In Ihrem Organisationsprofil geben Sie den Speicherort (öffentliche URL) der Angebotsbedingungen.

Nachdem Sie einen Preisplan veröffentlicht haben, wird die aktuelle Version der Nutzungsbedingungen im Entwicklerportals. Entwickler können erst dann einen Tarif erwerben, wenn sie den aktuellen Angebotsbedingungen.

Nutzungsbedingungen über die Benutzeroberfläche hinzufügen

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

    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 sind. Die Standardeinstellung ist die aktuelle Datum. Sie müssen das aktuelle oder ein zukünftiges Datum eingeben.

    Version

    Version der Nutzungsbedingungen. Mit der Versionsnummer können Sie Versionen der Nutzungsbedingungen verfolgen.

    URL

    URL der Nutzungsbedingungen.

  5. Klicken Sie auf Erstellen.

    Die neuen Nutzungsbedingungen werden im Abschnitt „Nutzungsbedingungen“ des Unternehmensprofils hinzugefügt. Seite.

  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 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 für die Nutzungsbedingungen hinzu.

Nutzungsbedingungen über die Benutzeroberfläche löschen

  1. Rufen Sie die Seite mit dem Unternehmensprofil auf, wie unter Seite mit dem Unternehmensprofil erkunden beschrieben.
  2. Klicken Sie auf der Seite „Organisationsprofil“ auf Bearbeiten.
  3. Bewegen Sie den Mauszeiger in der Liste der Nutzungsbedingungen auf die zu löschenden Nutzungsbedingungen.
  4. Klicken Sie auf .

Nutzungsbedingungen mithilfe der API verwalten

Verwalten Sie die 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 Folgendes angeben:

  • URL
  • Begleittext (z. B. eine Beschreibung)
  • Datum, an dem die Nutzungsbedingungen in Kraft sind
  • Versionsnummer

Weitere Informationen finden Sie unter Konfigurationseigenschaften für die Nutzungsbedingungen. Informationen zu diesen Optionen.

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

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

Bestimmte anzeigen Nutzungsbedingungen akzeptieren, indem wir eine GET-Anfrage an /mint/organizations/{org_name}/tncs/{tncs_id} senden, wobei {tncs_id} steht für die Identifizierung der jeweiligen Nutzungsbedingungen. Die ID wird im 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

Lesen Sie alle Nutzungsbedingungen der Organisation, indem Sie eine GET-Anfrage an /mint/organizations/{org_name}/tncs 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 die Nutzungsbedingungen eines bestimmten Entwicklers oder Unternehmens, indem Sie eine POST-Anfrage ausgeben. -Anfrage an eine der folgenden APIs:

  • /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

Lesen Sie die von einem bestimmten Entwickler oder Unternehmen akzeptierten Nutzungsbedingungen, indem Sie eine GET-Anfrage ausgeben. -Anfrage an eine der folgenden APIs:

  • /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

Nutzungsbedingungen bearbeiten, indem Sie eine PUT-Anfrage an /mint/organizations/{org_named}/tncs/{tncs_id}, wobei {tncs_id} der Wert in den Nutzungsbedingungen ein. Wenn Sie die Aktualisierung vornehmen, müssen Sie in der Anfrage angeben, die aktualisierten Einstellungen und die Nutzungsbedingungen an. Beispiel: die Versionsnummer für die Nutzungsbedingungen bearbeitet (die aktualisierte Eigenschaft ist in der Beispiel):

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 mithilfe der API löschen

Löschen Sie die Nutzungsbedingungen, indem Sie eine DELETE-Anfrage an /mint/organizations/{org_name}/tncs/{tncs_id}, wobei {tncs_id} der Wert in den Nutzungsbedingungen ein. 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 Version der Nutzungsbedingungen.

Ja
startDate

Datum, an dem die Nutzungsbedingungen in Kraft sind.

Ja
organization

Organisation für die Nutzungsbedingungen.

Nein

Nächste Schritte

Unter Unterstützte verwalten Währungen.