Zarządzaj Warunkami korzystania z usługi

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

Zanim opublikujesz plan stawek, musisz dodać warunki korzystania z usługi („Warunki”) do profilu organizacji. Warunki korzystania z usługi znajdują się poza profilem organizacji. W profilu organizacji musisz podać lokalizację (publiczny URL) swoich warunków korzystania z usługi.

Po opublikowaniu planu stawek w portalu dla deweloperów wyświetla się bieżąca wersja warunków. Deweloperzy mogą kupić abonament dopiero po zaakceptowaniu aktualnych Warunków korzystania z usługi.

Dodawanie warunków korzystania z usługi za pomocą interfejsu

  1. Otwórz stronę profilu organizacji w sposób opisany w sekcji Znajomość strony profilu organizacji.
  2. Kliknij Edytuj.
  3. W sekcji Warunki korzystania z usługi na stronie profilu organizacji kliknij Dodaj warunki.

    Wyświetli się okno Nowe warunki korzystania z usługi.

  4. Wprowadź następujące informacje:
    Pole Opis
    Data wejścia w życie

    Data obowiązywania warunków korzystania z usługi. Domyślna jest bieżąca data. Musisz podać datę bieżącą lub przyszłą.
    Wersja

    Wersja warunków korzystania z usługi. Numer wersji umożliwia śledzenie różnych wersji warunków korzystania z usługi.
    URL

    Adres URL strony z Warunkami korzystania z usługi.
  5. Kliknij Utwórz.

    Nowe warunki zostaną dodane do sekcji Warunki w profilu organizacji.

  6. Powtórz kroki 3–5, aby dodać dodatkowe warunki.
  7. Aby zapisać zmiany w profilu organizacji, kliknij Zapisz.

Edytowanie warunków korzystania z usługi za pomocą interfejsu

Warunków usługi nie można edytować bezpośrednio. Zamiast tego musisz usunąć warunki korzystania z usługi, które chcesz edytować, a następnie dodać nowy wpis.

Usuwanie warunków korzystania z usługi za pomocą interfejsu użytkownika

  1. Otwórz stronę profilu organizacji w sposób opisany w sekcji Przeglądanie strony profilu organizacji.
  2. Na stronie profilu organizacji kliknij Edytuj.
  3. Na liście warunków użyj kursora, aby wskazać warunki, które chcesz usunąć.
  4. Kliknij .

Zarządzanie warunkami korzystania z usługi za pomocą interfejsu API

Zarządzaj warunkami korzystania z usługi za pomocą interfejsu API zgodnie z opisem w kolejnych sekcjach.

Dodawanie warunków korzystania z usługi za pomocą interfejsu API

Dodaj warunki, wysyłając żądanie POST do /mint/organizations/{org_name}/tncs. Podczas dodawania warunków korzystania z usługi możesz opcjonalnie określić:

  • URL
  • tekst towarzyszący (np. opis);
  • Data, od której obowiązują warunki
  • Numer wersji

Więcej informacji o tych opcjach znajdziesz w sekcji Właściwości konfiguracji warunków.

Na przykład:

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

Poniżej przedstawiamy przykład odpowiedzi:

{
   "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"
 }

Wyświetlanie warunków korzystania z usługi za pomocą interfejsu API

wyświetlać konkretne warunki lub wszystkie warunki korzystania z usługi w organizacji.

Aby wyświetlić konkretne warunki, wyślij żądanie GET do adresu /mint/organizations/{org_name}/tncs/{tncs_id}, gdzie {tncs_id} to identyfikator konkretnych warunków (identyfikator jest zwracany w odpowiedzi na żądanie przesłane podczas tworzenia warunków). Na przykład:

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

Aby wyświetlić wszystkie warunki korzystania z usługi dla organizacji, wyślij żądanie GET do adresu /mint/organizations/{org_name}/tncs. Na przykład:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Accept: application/json" \
  -u email:password

Poniżej przedstawiamy przykład odpowiedzi:

{

"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
}

Zaakceptowanie dokumentu z warunkami dla dewelopera lub firmy korzystającej z interfejsu API

Zaakceptuj dokument Warunki dla konkretnego dewelopera lub firmy, wysyłając żądanie POST do jednego z tych interfejsów API:

  • /mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs

Gdzie {dev_id} to identyfikator dewelopera (adres e-mail), {company_id} to identyfikator firmy, a {tncs_id} to identyfikator dokumentu z zasadami i warunkami.

Na przykład:

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

Poniżej przedstawiamy przykład odpowiedzi:

Uwaga: w ładunku odpowiedzi wartość auditDate jest ustawiona na aktualny czas w UTC.
{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

Wyświetlanie warunków korzystania z usługi zaakceptowanych przez dewelopera lub firmę korzystającą z interfejsu API

Aby wyświetlić warunki zaakceptowane przez konkretnego dewelopera lub firmę, wyślij żądanie GET do jednego z tych interfejsów API:

  • /mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
  • /mint/organizations/{org_name}/companies/{company_id}/developer-tncs

Gdzie {dev_id} to identyfikator dewelopera (adres e-mail), a {company_id} to identyfikator firmy.

Na przykład:

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

Poniżej przedstawiamy przykład odpowiedzi:

{
  "developerTnc": [
  {
    "action": "ACCEPTED",
    "auditDate": "2018-08-29 07:24:45",
    "id": "dev2@myorg.com",
    "tnc": {
      "id": "26abc14c-c628-4c38-8840-a343c8ee9437",
      ...
    }
  }],
  "totalRecords": 1
}

Edytowanie warunków korzystania z usługi za pomocą interfejsu API

Aby edytować warunki korzystania z usługi, wyślij żądanie PUT do adresu /mint/organizations/{org_named}/tncs/{tncs_id}, gdzie {tncs_id} to identyfikator warunków korzystania z usługi. Podczas aktualizacji musisz podać w jej treści zaktualizowane ustawienia i identyfikator warunków korzystania z usługi. Na przykład to żądanie zmienia numer wersji regulaminu (w przykładzie wyróżniono zaktualizowaną właściwość):

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

Poniżej przedstawiamy przykład odpowiedzi:

{
   "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"
 }

Usuwanie warunków korzystania z usługi za pomocą interfejsu API

Usuń Warunki, wysyłając żądanie DELETE do /mint/organizations/{org_name}/tncs/{tncs_id}, gdzie {tncs_id} to ich identyfikator. Na przykład:

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

Właściwości konfiguracji warunków korzystania z usługi dotyczącej interfejsu API

W tabeli poniżej znajdziesz podsumowanie właściwości konfiguracji, które można ustawić za pomocą interfejsu API w warunkach korzystania z usługi.

Nazwa Opis Domyślny Wymagany?
url

Adres URL warunków korzystania z usługi.

 Nie dotyczy Nie
tncText

Tekst (np. krótki opis) warunków korzystania z usługi.

 Nie dotyczy Nie
version

Wersja Warunków korzystania z usługi. Numer wersji pozwala śledzić różne wersje Warunków.

 Nie dotyczy Tak
startDate

Data wejścia w życie Warunków korzystania z usługi.

 Nie dotyczy Tak
organization

Organizacja, której dotyczą warunki.

 Nie dotyczy Nie

Dalsze kroki

Aby dowiedzieć się, jak dodać obsługiwane waluty do początkowo skonfigurowanych dla organizacji, przeczytaj artykuł Zarządzanie obsługiwanymi walutami.