Zarządzaj Warunkami korzystania z usługi

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

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

Po opublikowaniu planu cen bieżąca wersja warunków jest wyświetlana w portalu dla programistów. Deweloperzy mogą kupić pakiet dopiero po zaakceptowaniu obecnych warunków.

Dodawanie warunków korzystania z usługi w interfejsie

  1. Otwórz stronę Profil organizacji zgodnie z opisem w sekcji Przeglądanie strony Profil organizacji.
  2. Kliknij Edytuj.
  3. W sekcji Warunki korzystania z usługi na stronie Profil organizacji kliknij Dodaj warunki korzystania z usługi.

    Pojawi się okno Nowe warunki korzystania z usługi

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

    Data wejścia w życie warunków korzystania z usługi. Domyślną datą jest bieżąca data. Musisz podać datę bieżącą lub przyszłą.
    Wersja

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

    URL warunków korzystania z usługi.
  5. Kliknij Utwórz.

    Nowe warunki zostaną dodane do sekcji Warunki na stronie Profil organizacji.

  6. Powtarzaj kroki od 3 do 5, by dodać kolejne warunki korzystania z usługi.
  7. Kliknij Zapisz, aby zapisać zmiany w profilu organizacji.

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

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

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

  1. Otwórz stronę Profil organizacji zgodnie z opisem w sekcji Przeglądanie strony Profil organizacji.
  2. Kliknij Edytuj na stronie Profil organizacji.
  3. Na liście warunków umieść kursor nad tymi warunkami, 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 w sposób opisany w sekcjach poniżej.

Dodawanie warunków korzystania z usługi przy użyciu interfejsu API

Dodaj warunki, wysyłając żądanie POST do /mint/organizations/{org_name}/tncs. Dodając warunki, możesz opcjonalnie określić:

  • URL
  • Tekst towarzyszący (np. opis)
  • Data wejścia w życie warunków
  • Numer wersji

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

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 znajdziesz przykładową odpowiedź:

{
   "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 przy użyciu interfejsu API

Wyświetlanie konkretnych warunków lub wszystkich warunków obowiązujących w danej organizacji.

Wyświetl konkretne warunki, wysyłając żądanie GET do usługi /mint/organizations/{org_name}/tncs/{tncs_id}, gdzie {tncs_id} oznacza konkretne warunki (identyfikator jest zwracany w odpowiedzi po ich utworzeniu). 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

Wyświetl wszystkie warunki korzystania z usługi obowiązujące w tej organizacji, wysyłając żądanie GET do /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 znajdziesz przykładową odpowiedź:

{

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

Akceptowanie dokumentu z warunkami korzystania z usługi w przypadku dewelopera lub firmy korzystającej z interfejsu API

Zaakceptuj warunki korzystania z usługi w przypadku konkretnego dewelopera lub firmy, wysyłając żądanie POST odpowiednio 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 warunków korzystania z usługi.

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 znajdziesz przykładową odpowiedź:

Uwaga: w ładunku odpowiedzi parametr auditDate jest ustawiony na bieżący czas w strefie czasowej 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ę za pomocą interfejsu API

Wyświetl warunki korzystania z usługi zaakceptowane przez konkretnego dewelopera lub firmę, wysyłając żądanie GET odpowiednio 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 znajdziesz przykładową odpowiedź:

{
  "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 przy użyciu interfejsu API

Aby edytować warunki, wyślij żądanie PUT do: /mint/organizations/{org_named}/tncs/{tncs_id}, gdzie {tncs_id} to dane umożliwiające ich identyfikację. Podczas aktualizacji musisz podać w treści żądania zaktualizowane ustawienia oraz identyfikację warunków. Na przykład to żądanie zmienia numer wersji warunków (zaktualizowana właściwość jest w tym przykładzie wyróżniona):

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 znajdziesz przykładową odpowiedź:

{
   "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 przy użyciu interfejsu API

Aby usunąć Warunki korzystania z usługi, wyślij do użytkownika /mint/organizations/{org_name}/tncs/{tncs_id} żądanie usunięcia, gdzie {tncs_id} oznacza warunki. 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 interfejsu API

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

Nazwa Opis Domyślne Wymagana?
url

Adres URL warunków.

 Nie dotyczy Nie
tncText

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

 Nie dotyczy Nie
version

Wersja warunków. Numer wersji umożliwia śledzenie różnych wersji warunków.

 Nie dotyczy Tak
startDate

Data wejścia warunków w życie.

 Nie dotyczy Tak
organization

Organizacja Warunków korzystania z usługi.

 Nie dotyczy Nie

Dalsze kroki

Aby dowiedzieć się, jak dodać obsługiwane waluty do walut, które zostały początkowo skonfigurowane w Twojej organizacji, przeczytaj artykuł Zarządzanie obsługiwanymi walutami.