Acquisto e gestione degli abbonamenti ai prodotti API utilizzando l'API

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Se vuoi creare il tuo portale personalizzato o gestire il processo di acquisto manualmente, le sezioni seguenti descrivono come acquistare e gestire gli abbonamenti ai prodotti API utilizzando l'API. Vedi anche Integrare la monetizzazione di Apigee nel tuo portale per gli sviluppatori basato su Drupal.

Acquisto di abbonamenti ai prodotti API utilizzando l'API

Per acquistare l'abbonamento a un prodotto API, invia una richiesta POST alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Configura la richiesta di abbonamento al prodotto API passando i campi obbligatori nel corpo della richiesta, come descritto in Risorsa: abbonamenti.

Ad esempio, la seguente chiamata API acquista un abbonamento al prodotto API HelloworldProduct per lo sviluppatore specificato:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{"apiproduct":"HelloworldProduct"}'

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'output della risposta. startTime è impostato sull'ora attuale.

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

Per ulteriori informazioni, consulta la pagina dedicata all'API Purchase API Product Subscription

L'abbonamento a un prodotto API scade immediatamente

Per far scadere immediatamente l'abbonamento a un prodotto API, invia una richiesta POST alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

Ad esempio, la seguente chiamata API fa scadere l'abbonamento al prodotto API con il nome 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 per lo sviluppatore specificato:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72:expire" \
  -X POST \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'output della risposta. endTime è impostato sull'ora attuale.

{
  "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
  "apiproduct": "WeatherReport",
  "startTime": "1613494852000",
  "endTime" : "1617894954000",
  "createdAt": "1613494852000",
  "lastModifiedAt": "1613494852000"
}

Elenco di tutti gli abbonamenti ai prodotti API per uno sviluppatore

Per elencare tutti gli abbonamenti ai prodotti API di uno sviluppatore, invia una richiesta GET alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Facoltativamente, puoi passare i seguenti campi per supportare l'impaginazione:

  • startKey per specificare il nome dell'abbonamento del prodotto API da cui iniziare a visualizzare l'elenco degli abbonamenti. Se omesso, l'elenco inizia dal primo elemento. Utilizzalo con count per fornire filtri più mirati. Ad esempio, per visualizzare gli abbonamenti ai prodotti API da 51 a 150, imposta il valore di startKey sul nome della sottoscrizione 51 e imposta il valore di count su 100.
  • count per specificare il numero di piani tariffari da restituire nella chiamata API. Utilizzalo con startKey per fornire filtri più mirati. Il limite massimo è 1000. Il valore predefinito è 100.

Ad esempio, la seguente chiamata API elenca tutti gli abbonamenti ai prodotti API per lo sviluppatore specificato:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'output di risposta:

{
  "developerSubscriptions": [
    {
      "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
      "apiproduct": "HelloworldProduct",
      "startTime": "1615987132000",
      "createdAt": "1615903252000",
      "lastModifiedAt": "1615903252000"
    },
    {
      "name": "33f8dd42-c7x5-3s3f-b098-d=c93h22m36b47",
      "apiproduct": "WeatherReport",
      "startTime": "1614124552000",
      "createdAt": "1613494852000",
      "lastModifiedAt": "1613494852000"
    }
  ]
}

Per ulteriori informazioni, consulta la pagina dedicata all'API List API Product Subscriptions.

Visualizzare i dettagli dell'abbonamento a un prodotto API

Per visualizzare i dettagli dell'abbonamento a un prodotto API per uno sviluppatore, invia una richiesta GET alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

Ad esempio, la seguente chiamata API elenca tutti gli abbonamenti ai prodotti API per lo sviluppatore specificato:

curl "https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/69f8bb42-a8e4-4a2c-b932-d82b51d37b72" \
  -X GET \
  -H "Authorization: Bearer $TOKEN"

Dove $TOKEN è impostato sul token di accesso OAuth 2.0, come descritto in Ottenere un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzare curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'output di risposta:

{
   "name": "69f8bb42-a8e4-4a2c-b932-d82b51d37b72",
   "apiproduct": "HelloworldProduct",
   "startTime": "1615987132000",
   "createdAt": "1615903252000",
   "lastModifiedAt": "1615903252000"
}

Per ulteriori informazioni, consulta la sezione Get API product subscription.