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

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza Apigee Edge documentazione.

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. Questi esempi descrivono come gestire gli abbonamenti per gli sviluppatori di app e gli AppGroup.

Vedi anche Integrare la monetizzazione di Apigee nel portale per sviluppatori basato su Drupal.

Gestione degli abbonamenti degli sviluppatori di app

Sviluppatore di app: acquista gli abbonamenti ai prodotti API utilizzando l'API

Per acquistare un abbonamento a un prodotto API, invia una POST richiesta 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 Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di output della risposta. startTime è impostato sull'ora corrente.

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

Per saperne di più, consulta l'API Acquista abbonamento al prodotto API.

Sviluppatore di app: fai scadere immediatamente un abbonamento a un prodotto API

Per far scadere immediatamente un abbonamento a un prodotto API, invia una POST richiesta 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 Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di 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"
}

Sviluppatore di app: elenca tutti gli abbonamenti ai prodotti API per uno sviluppatore

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

Facoltativamente, puoi passare i seguenti campi per supportare la paginazione:

  • startKey per specificare il nome dell'abbonamento al prodotto API da cui iniziare a visualizzare l'elenco degli abbonamenti. Se omesso, l'elenco inizia dal primo elemento. Utilizza questo campo con count per fornire un filtro più mirato. Ad esempio, per visualizzare gli abbonamenti ai prodotti API da 51 a 150, imposta il valore di startKey sul nome del 51° abbonamento e il valore di count su 100.
  • count per specificare il numero di piani tariffari da restituire nella chiamata API. Utilizza questo campo con startKey per fornire 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 token di accesso OAuth 2.0, come descritto in Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di 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 saperne di più, consulta l'API Elenca abbonamenti ai prodotti API.

Sviluppatore di app: visualizza i dettagli di un abbonamento a un prodotto API

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

Ad esempio, la seguente chiamata API recupera i dettagli di un abbonamento a un prodotto 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 Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, 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 saperne di più, consulta l'API Ottieni abbonamento al prodotto API.

Gestione degli abbonamenti degli AppGroup

Questa sezione fornisce esempi per la gestione degli abbonamenti ai prodotti API per gli AppGroup. Per ulteriori informazioni sulle API utilizzate per la gestione degli abbonamenti degli AppGroup, consulta Risorsa: abbonamenti.

AppGroup: acquista gli abbonamenti ai prodotti API utilizzando l'API

Per informazioni sui requisiti per l'utilizzo degli AppGroup con gli abbonamenti ai prodotti API, consulta Utilizzare gli AppGroup per gestire gli abbonamenti ai prodotti API.

Per acquistare un abbonamento a un prodotto API, invia una POST richiesta alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/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 HelloworldProduct prodotto API per l'AppGroup specificato: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/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 Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di output della risposta. startTime è impostato sull'ora corrente.

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

Per saperne di più, consulta l'API Acquista abbonamento al prodotto API.

AppGroup: fai scadere immediatamente un abbonamento a un prodotto API

Per far scadere immediatamente un abbonamento a un prodotto API, invia una POST richiesta alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/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 l'AppGroup specificato: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/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 Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostare le variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio di 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"
}

AppGroup: elenca tutti gli abbonamenti ai prodotti API

Per elencare tutti gli abbonamenti ai prodotti API per un AppGroup, invia una GET richiesta alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions

Facoltativamente, puoi passare i seguenti campi per supportare la paginazione:

  • startKey per specificare il nome dell'abbonamento al prodotto API da cui iniziare a visualizzare l'elenco degli abbonamenti. Se omesso, l'elenco inizia dal primo elemento. Utilizza questo campo con count per fornire un filtro più mirato. Ad esempio, per visualizzare gli abbonamenti ai prodotti API da 51 a 150, imposta il valore di startKey sul nome del 51° abbonamento e il valore di count su 100.
  • count per specificare il numero di piani tariffari da restituire nella chiamata API. Utilizza questo campo con startKey per fornire 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 l'AppGroup specificato: 

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

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

Di seguito è riportato un esempio di output della risposta:

{
  "appGroupSubscriptions": [
    {
      "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 saperne di più, consulta l'API Elenca abbonamenti ai prodotti API.

AppGroup: visualizza i dettagli di un abbonamento a un prodotto API

Per visualizzare i dettagli di un abbonamento a un prodotto API per un AppGroup, invia una GET richiesta alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION

Ad esempio, la seguente chiamata API elenca le informazioni per un abbonamento a un prodotto API per un AppGroup specificato: 

curl "https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/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 Ottieni un token di accesso OAuth 2.0. Per informazioni sulle opzioni curl utilizzate in questo esempio, consulta Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, 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 saperne di più, consulta l'API Ottieni abbonamento al prodotto API.