Acquisto e gestione di abbonamenti ai prodotti API tramite l'API

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

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

Acquisto di abbonamenti ai prodotti API tramite l'API

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

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

Ad esempio, la seguente chiamata API consente di acquistare 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 tuo 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, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta. Su startTime è impostata l'ora attuale.

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

Per ulteriori informazioni, consulta l'API di abbonamento ai prodotti dell'API Purchase

L'abbonamento al prodotto API scade immediatamente

Per far scadere immediatamente un 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 scade 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 tuo 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, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito viene fornito un esempio dell'output della risposta. endTime è impostato sull'ora corrente.

{
  "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 per 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 al prodotto API da cui iniziare a visualizzare l'elenco degli abbonamenti. Se viene omesso, l'elenco inizia dal primo elemento. Da utilizzare con count per offrire filtri più mirati. Ad esempio, per visualizzare gli abbonamenti ai prodotti API da 51 a 150, imposta il valore di startKey sul nome del 51° abbonamento e imposta il valore di count su 100.
  • count per specificare il numero di piani tariffari da includere nella chiamata API. Da utilizzare con startKey per applicare un filtro più mirato. 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 tuo 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, vedi Con curl. Per una descrizione delle variabili di ambiente utilizzate, consulta Impostazione delle variabili di ambiente per le richieste dell'API Apigee.

Di seguito viene fornito un esempio dell'output della 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 relativa all'API List API product Subscriptions.

Visualizzazione dei dettagli sull'abbonamento a un prodotto API

Per visualizzare i dettagli di un abbonamento al 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 tutte le sottoscrizioni 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 tuo 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 Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di output della risposta:

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

Per ulteriori informazioni, consulta la pagina relativa all'API Get API Product Subscription.