Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Wprowadzenie
Przed opublikowaniem planu stawek musisz dodać warunki korzystania z usługi („Warunki”) do profilu organizacji. Warunki te znajdują się poza organizacją profil. W profilu organizacji musisz określić lokalizację (publiczny adres URL), Warunki
Po opublikowaniu planu stawek bieżąca wersja Warunków jest wyświetlana w portalu dla programistów. Deweloperzy mogą kupić abonament dopiero po zaakceptowaniu bieżącej Warunki
Dodawanie warunków korzystania z usługi za pomocą interfejsu użytkownika
- Otwórz stronę Profil organizacji zgodnie z opisem w sekcji Przeglądanie strony Profil organizacji.
- Kliknij Edytuj.
- W sekcji Warunki korzystania z usługi na stronie Profil organizacji kliknij Dodaj warunki
.
Wyświetli się okno z nowymi warunkami korzystania z usługi
- Wprowadź następujące informacje:
Pole Opis Data wejścia w życie Data wejścia w życie Warunków korzystania z usługi. Wartością domyślną jest bieżący datę. Musisz podać datę bieżącą lub przyszłą.
Wersja Wersja warunków korzystania z usługi. Numer wersji umożliwia zachowanie śledzić różne wersje warunków korzystania z usługi.
URL Adres URL warunków korzystania z usługi.
- Kliknij Utwórz.
Nowe Warunki korzystania z usługi zostaną dodane do sekcji Warunki korzystania z usługi w profilu organizacji. stronę.
- Aby dodać więcej warunków korzystania z usługi, powtórz kroki od 3 do 5.
- Kliknij Zapisz, aby zapisać zmiany w profilu organizacji.
Edytowanie warunków za pomocą interfejsu użytkownika
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 następnie dodaj nowy wpis z warunkami korzystania z usługi.
Usuwanie warunków korzystania z usługi za pomocą interfejsu użytkownika
- Otwórz stronę Profil organizacji zgodnie z opisem w sekcji Przeglądanie strony Profil organizacji.
- Na stronie Profil organizacji kliknij Edytuj.
- Na liście warunków najedź kursorem na te, które chcesz usunąć.
- Kliknij
.
Zarządzanie warunkami korzystania z usługi za pomocą interfejsu API
Zarządzaj warunkami za pomocą interfejsu API w sposób opisany w sekcjach poniżej.
Dodawanie warunków korzystania z usługi za pomocą 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
Dodatkowe informacje znajdziesz w sekcji Właściwości konfiguracji Warunków korzystania z usługi. informacje na temat tych opcji.
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
Oto przykład takiej 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świetlanie konkretnych warunków lub wszystkich warunków organizacji.
Wyświetl określony widok
warunków przez wysłanie żądania GET do usługi /mint/organizations/{org_name}/tncs/{tncs_id}
, gdzie
{tncs_id}
umożliwia identyfikację konkretnych warunków (identyfikator jest zwracany w
podczas tworzenia Warunków korzystania z usługi). 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 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
Oto przykład takiej 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 }
Akceptowanie dokumentu z Warunkami korzystania z usługi dla dewelopera lub firmy korzystającej z interfejsu API
Zaakceptuj dokument z warunkami korzystania z usługi określonego dewelopera lub firmy, wysyłając 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 Warunkami 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
Oto przykład takiej odpowiedzi:
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 zaakceptowane przez konkretnego dewelopera lub firmę, wysyłając metodę 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
Oto przykład takiej 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 przy użyciu interfejsu API
Edytować warunki, wysyłając żądanie PUT do
/mint/organizations/{org_named}/tncs/{tncs_id}
, gdzie {tncs_id}
to
określić Warunki korzystania z usługi. W przypadku aktualizacji musisz wskazać w żądaniu
zaktualizowane ustawienia oraz Warunki korzystania z usługi. Na przykład:
może poprosić o zmianę numeru wersji Warunków (zaktualizowana usługa jest wyróżniona
przykład):
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
Oto przykład takiej 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
określić Warunki korzystania z usługi. 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żna ustawić za pomocą interfejsu API w warunkach korzystania z usługi.
Nazwa | Opis | Domyślny | Wymagana? |
---|---|---|---|
url |
Adres URL Warunków. |
Nie dotyczy | Nie |
tncText |
Tekst (np. krótki opis) warunków. |
Nie dotyczy | Nie |
version |
Wersja warunków. Numer wersji pozwala śledzić różne wersji Warunków. |
Nie dotyczy | Tak |
startDate |
Data wejścia w życie Warunków. |
Nie dotyczy | Tak |
organization |
Organizacja warunków. |
Nie dotyczy | Nie |
Dalsze kroki
Dowiedz się, jak dodać obsługiwane waluty do walut skonfigurowanych początkowo dla Twojej organizacji w Zarządzaj obsługiwanymi walutami.