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

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Se vuoi creare un 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 Apigee nel portale per sviluppatori basato su Drupal.

Gestione degli abbonamenti degli sviluppatori di app

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

Per acquistare un 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 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 la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, 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 saperne di più, consulta la Purchase API product subscription API.

Sviluppatore di app: scadenza immediata di un abbonamento a un prodotto API

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, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, 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"
}

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 richiesta GET alla seguente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Se vuoi, 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. Utilizzalo con count per un filtraggio 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. Utilizzalo con startKey per un filtraggio 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, consulta la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato 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 saperne di più, consulta la pagina relativa all'API List API product subscriptions.

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 richiesta GET 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 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 la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

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

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

Per saperne di più, consulta la pagina relativa all'API Get API product subscription.

Gestione degli abbonamenti AppGroup

Questa sezione fornisce esempi per la gestione degli abbonamenti ai prodotti API per i gruppi di app. Per ulteriori informazioni sulle API utilizzate per la gestione degli abbonamenti ai gruppi di app, consulta Risorsa: Abbonamenti.

AppGroup: Acquisto di abbonamenti ai prodotti API tramite l'API

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

Per acquistare un abbonamento a un prodotto API, invia una richiesta POST 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 prodotto API HelloworldProduct 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 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 la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, 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 saperne di più, consulta la Purchase API product subscription API.

AppGroup: Expire an API product subscription immediately

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

Ad esempio, la seguente chiamata API scade 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 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 la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, 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"
}

AppGroup: List all API product subscriptions

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

Se vuoi, 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. Utilizzalo con count per un filtraggio 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. Utilizzalo con startKey per un filtraggio 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 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 la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

Di seguito è riportato un esempio dell'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 la pagina relativa all'API List API product subscriptions.

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

Per visualizzare i dettagli di un abbonamento a un prodotto API per un gruppo di app, invia una richiesta GET 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 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 la sezione Utilizzo di curl. Per una descrizione delle variabili di ambiente che puoi utilizzare, consulta Impostazione delle variabili di ambiente per le richieste API Apigee.

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

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

Per saperne di più, consulta la pagina relativa all'API Get API product subscription.