Plany zakupów za pomocą interfejsu API

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

W tej sekcji dowiesz się, jak kupić opublikowany abonament oraz wygasać i anulować zakup plan stawek (w razie potrzeby) za pomocą interfejsu API.

Kupowanie opublikowanego planu stawek przy użyciu interfejsu API

Po opublikowaniu planu stawek deweloper lub firma może go kupić (lub zaakceptować) do wysyłając żądanie POST do /mint/organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans, gdzie {org_name} to nazwa organizacji, {developer_or_company_id} to identyfikator dewelopera lub firmy.

Aby zrezygnować z opłat konfiguracyjnych przy zakupie abonamentu, ustaw parametr zapytania waivefees do: true. Jest to przydatne, gdy przenosisz programistów do opcji zarabiania, opisane w sekcji Migracja programistów do zarabiania.

W tabeli poniżej znajdziesz podsumowanie właściwości konfiguracji, które możesz określić w polu treści żądania, ich wartości domyślnych i tego, czy są wymagane.

Na przykład to żądanie kupuje abonament location_&_messaging dla określonego dewelopera:

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "startDate":"2017-08-30",
   "ratePlan":{
     "id":"location_&_messaging"
   },
   "suppressWarning":false
  }'

W tym przykładzie właściwość suppressWarning jest ustawiona na false. W w takim przypadku w przypadku konfliktu wystąpi błąd. Jeśli na przykład deweloper próbuje kupić plan stawek, który pokrywa się z innym kupionym planem stawek, pojawia się błąd. Ten udostępnia aplikację, która udostępnia interfejs do zarabiania, aby przechwytywać błędy i korzystać wyświetl deweloperowi produkty będące w konflikcie w celu potwierdzenia (w stosownych przypadkach). Jeśli suppressWarning ma wartość true, zarabianie spowoduje przerwanie wszystkich zakupów abonamentów API, które zawierają produkty powodujące konflikt. Następnie kupuje dla dewelopera nowy pakiet API.

To żądanie kupuje plan stawek powiadomień z możliwością dostosowania i ustawia docelową liczbę transakcji do 4000.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/developer-rateplans" \
  -X POST \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "developer":{
     "id":"5cTWgdUvdr6JW3xU"
   },
   "ratePlan":{
     "id":"adjustable-notification-plan"
   },
   "startDate": "2017-03-24",
   "quotaTarget": 4000,
   "suppressWarning":false
  }'

Jeśli w dowolnym z powyższych przykładów zostanie zwrócony następujący komunikat o błędzie:

Developer legal name not specified. 

Następnie musisz ustawić atrybuty zarabiania MINT_DEVELOPER_ADDRESS i MINT_DEVELOPER_LEGAL_NAME, a następnie powtórz wywołanie interfejsu API.

Utrata ważności abonamentu zakupionego przez dewelopera za pomocą interfejsu API

Aby wygasnąć (lub anulować) abonament kupiony przez dewelopera, zaktualizuj kupiony szczegóły abonamentu i określ właściwość endDate w treści żądania w żądanie PUT do w zasobie /organizations/{org_name}/developers/{developer_or_company_id}/developer-rateplans/{developer_rateplan_id}.

Abonament będzie obowiązywał do końca dnia tego dnia datę. Jeśli na przykład chcesz zakończyć abonament 1 grudnia 2017 roku, ustaw wartość endDate. (30.11.2017). W tym przypadku parametr abonament wygaśnie wraz z końcem dnia 30 listopada 2017 r. wszystkie żądania z 1 grudnia, 2017 zostanie zablokowany.

Gdy dokonasz zakupu, w odpowiedzi zostanie zwrócony kod {developer_rateplan_id}. w opublikowanym planie stawek.

Na przykład:

{
  "created": "2017-03-31 18:59:54",
  "developer": {
    ...
  },
  "id": "b1c600b8-f871-496d-8173-12b9950d6ab1",
  "quotaTarget": 3000,
  "ratePlan": {
    ...
  },
  "startDate": "2017-03-31 00:00:00",
  "updated": "2017-03-31 18:59:54",
  "waiveTerminationCharge": false
}

Możesz również uzyskać {developer-rateplan-id} dla plan stawek dla deweloperów przez wysłanie żądania GET do: /organizations/{org_name}/developers/{developer_id}/developer-accepted-rateplans, gdzie {developer_id} to adres e-mail dewelopera. Więcej można znaleźć w sekcji Wyświetlanie wszystkich planów stawek kupionych przez dewelopera.

Ta prośba zmienia datę końcową na 1 grudnia 2017 roku. Plan taryfowy wygaśnie wraz z końcem tego dnia, czyli 30 listopada 2017 r., wszystkie prośby przesłane do 1 grudnia 2017 r. Użytkownik został zablokowany.

curl "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/developers/dev@mycompany.com/developer-rateplans/b1c600b8-f871-496d-8173-12b9950d6ab1"
  -X PUT \
  -H "Content-Type:application/json" \
  -u email:password \
  -d '{
   "id" : "b1c600b8-f871-496d-8173-12b9950d6ab1",
   "developer":{
     "id":"dev@mycompany.com"
   },
   "ratePlan":{
     "id":"p1_adjustable-notification-plan"
   },
   "startDate": "2017-04-15 00:00:00",
   "endDate": "2017-11-30",
   "quotaTarget": 3000,
   "suppressWarning":false
  }'