Adquiere y administra suscripciones de productos de API mediante la API

Estás viendo la documentación de Apigee X.
Consulta la documentación de Apigee Edge.

Si deseas compilar tu propio portal personalizado o administrar el proceso de compra de forma manual, en las siguientes secciones se describe cómo comprar y administrar suscripciones de productos de API con la API. Consulta también Integra la monetización de Apigee en tu portal para desarrolladores basado en Drupal.

Comprar suscripciones de productos de API con la API

Para comprar una suscripción al producto de API, envía una solicitud POST a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

Para configurar la solicitud de suscripción del producto de API, pasa los campos obligatorios en el cuerpo de la solicitud, como se describe en Recurso: Suscripciones.

Por ejemplo, en la siguiente llamada a la API, se compra una suscripción al producto de API HelloworldProduct para el desarrollador 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"}'

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Para obtener una descripción de las variables de entorno utilizadas, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta: startTime se establece en la hora actual.

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

Para obtener más información, consulta la API de suscripción a productos de la API de comprar

Caduca una suscripción de producto de API de inmediato

Para caducar de inmediato una suscripción a un producto de API, envía una solicitud POST a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION:expire

Por ejemplo, la siguiente llamada a la API caduca la suscripción de producto de API con el nombre 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 para el desarrollador 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"

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Para obtener una descripción de las variables de entorno utilizadas, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta: endTime se establece en la hora actual.

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

Enumera todas las suscripciones a productos de API para un desarrollador

A fin de crear una lista de todas las suscripciones de producto de API para un desarrollador, envía una solicitud GET a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

De manera opcional, puedes pasar los siguientes campos para admitir la paginación:

  • startKey para especificar el nombre de la suscripción del producto de la API a partir de la cual se comenzará a mostrar la lista de suscripciones. Si se omite, la lista comienza desde el primer elemento. Úsalo con count para proporcionar un filtrado más orientado. Por ejemplo, para ver las suscripciones de productos de API entre 51 y 150, establece el valor de startKey en el nombre de la suscripción 51 y establece el valor de count en 100.
  • count para especificar la cantidad de planes de tarifas que se mostrarán en la llamada a la API. Úsalo con startKey para proporcionar un filtrado más orientado. El límite máximo es 1,000. La configuración predeterminada es 100.

Por ejemplo, en la siguiente llamada a la API, se enumeran todas las suscripciones de producto de API para el desarrollador especificado:

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

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Si deseas obtener una descripción de las variables de entorno que se usaron, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta:

{
  "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 obtener más información, consulta la API de suscripciones a productos de la API de enumerar.

Visualiza detalles sobre una suscripción de producto de API

Para ver los detalles de una suscripción de producto de API a un desarrollador, envía una solicitud GET a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions/$SUBSCRIPTION

Por ejemplo, en la siguiente llamada a la API, se enumeran todas las suscripciones a productos de API para el desarrollador especificado:

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

En el ejemplo anterior, $TOKEN está configurado como tu token de acceso de OAuth 2.0, como se describe en Obtén un token de acceso de OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usa curl. Si deseas obtener una descripción de las variables de entorno que se usaron, consulta Configura variables de entorno para solicitudes a la API de Apigee.

A continuación, se proporciona un ejemplo del resultado de la respuesta:

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

Para obtener más información, consulta la API de suscripción a productos de la API de obtener.