Comprar e gerir subscrições de produtos de API através da API

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Se quiser criar o seu próprio portal personalizado ou gerir o processo de compra manualmente, as secções seguintes descrevem como comprar e gerir subscrições de produtos de API através da API. Estes exemplos descrevem como gerir subscrições para programadores de apps e AppGroups.

Consulte também o artigo Integre a rentabilização do Apigee no seu portal do programador baseado no Drupal.

Gestão de subscrições do programador de apps

Programador de apps: compre subscrições de produtos da API através da API

Para comprar uma subscrição de um produto de API, emita um pedido POST para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Configure o pedido de subscrição do produto API transmitindo os campos obrigatórios no corpo do pedido, conforme descrito em Recurso: subscrições.

Por exemplo, a seguinte chamada API compra uma subscrição do produto API HelloworldProduct para o programador especificado: 

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"}'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo do resultado da resposta. startTime está definido para a hora atual.

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

Para mais informações, consulte a API Purchase product subscription

Programador de apps: expire imediatamente uma subscrição de produto de API

Para fazer expirar imediatamente uma subscrição de um produto de API, emita um pedido POST para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

Por exemplo, a seguinte chamada da API faz expirar a subscrição do produto da API com o nome 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 para o programador especificado: 

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

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo do resultado da resposta. endTime está definido para a hora atual.

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

Programador de apps: liste todas as subscrições de produtos de API para um programador

Para listar todas as subscrições de produtos de API de um programador, emita um pedido GET para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Opcionalmente, pode transmitir os seguintes campos para suportar a paginação:

  • startKey para especificar o nome da subscrição do produto API a partir da qual começar a apresentar a lista de subscrições. Se for omitido, a lista começa pelo primeiro item. Use com count para fornecer uma filtragem mais segmentada. Por exemplo, para ver as subscrições de produtos API de 51 a 150, defina o valor de startKey para o nome da 51.ª subscrição e defina o valor de count como 100.
  • count para especificar o número de planos tarifários a devolver na chamada da API. Use com startKey para fornecer uma filtragem mais segmentada. O limite máximo é 1000. A predefinição é 100.

Por exemplo, a seguinte chamada API apresenta todas as subscrições de produtos API para o programador especificado: 

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

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da saída da resposta:

{
  "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"
    }
  ]
}

Para mais informações, consulte a API List product subscriptions.

Programador de apps: veja os detalhes de uma subscrição de produto API

Para ver detalhes sobre uma subscrição de produto de API para um programador, emita um pedido GET para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

Por exemplo, a seguinte chamada API obtém detalhes sobre uma subscrição de produto API para o programador especificado: 

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

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da saída da resposta:

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

Para mais informações, consulte a API Get API product subscription.

Gestão de subscrições de grupos de apps

Esta secção fornece exemplos de gestão de subscrições de produtos de API para grupos de apps. Para mais informações sobre as APIs usadas para gerir subscrições de AppGroups, consulte Recurso: Subscrições.

AppGroup: compre subscrições de produtos da API através da API

Consulte o artigo Use AppGroups to manage API product subscriptions para obter informações sobre os requisitos para usar AppGroups com subscrições de produtos de API.

Para comprar uma subscrição de um produto API, emita um pedido POST para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions.

Configure o pedido de subscrição do produto API transmitindo os campos necessários no corpo do pedido, conforme descrito em Recurso: Subscrições.

Por exemplo, a seguinte chamada da API compra uma subscrição do produto da API HelloworldProduct para o AppGroup especificado: 

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"}'

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo do resultado da resposta. startTime está definido para a hora atual.

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

Para mais informações, consulte a API Purchase product subscription

AppGroup: expire imediatamente uma subscrição de produto API

Para fazer expirar imediatamente uma subscrição de um produto de API, emita um pedido POST para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION:expire

Por exemplo, a seguinte chamada da API faz expirar a subscrição do produto da API com o nome 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 para o AppGroup especificado: 

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

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo do resultado da resposta. endTime está definido para a hora atual.

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

AppGroup: List all API product subscriptions

Para listar todas as subscrições de produtos de API para um AppGroup, emita um pedido GET para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions

Opcionalmente, pode transmitir os seguintes campos para suportar a paginação:

  • startKey para especificar o nome da subscrição do produto API a partir da qual começar a apresentar a lista de subscrições. Se for omitido, a lista começa pelo primeiro item. Use com count para fornecer uma filtragem mais segmentada. Por exemplo, para ver as subscrições de produtos API de 51 a 150, defina o valor de startKey para o nome da 51.ª subscrição e defina o valor de count como 100.
  • count para especificar o número de planos tarifários a devolver na chamada da API. Use com startKey para fornecer uma filtragem mais segmentada. O limite máximo é 1000. A predefinição é 100.

Por exemplo, a seguinte chamada de API lista todas as subscrições de produtos de API para o AppGroup especificado: 

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

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da saída da resposta:

{
  "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"
    }
  ]
}

Para mais informações, consulte a API List product subscriptions.

AppGroup: veja detalhes sobre uma subscrição de produto API

Para ver detalhes sobre uma subscrição de produto de API para um AppGroup, emita um pedido GET para a seguinte API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION

Por exemplo, a seguinte chamada API apresenta informações sobre uma subscrição de produto API para um AppGroup especificado: 

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

Onde $TOKEN está definido como a sua chave de acesso OAuth 2.0, conforme descrito em Obter uma chave de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte a secção Usar o curl. Para uma descrição das variáveis de ambiente que pode usar, consulte o artigo Definir variáveis de ambiente para pedidos de API Apigee.

Segue-se um exemplo da saída da resposta:

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

Para mais informações, consulte a API Get API product subscription.