Comprar y gestionar suscripciones a productos de API mediante la API

Esta página se aplica a Apigee y Apigee hybrid.

Consulta la documentación de Apigee Edge.

Si quieres crear tu propio portal personalizado o gestionar el proceso de compra manualmente, en las siguientes secciones se describe cómo comprar y gestionar suscripciones a productos de API mediante la API. En estos ejemplos se describe cómo gestionar las suscripciones de desarrolladores de aplicaciones y AppGroups.

Consulta también el artículo Integrar la monetización de Apigee en un portal para desarrolladores basado en Drupal.

Gestión de suscripciones de desarrolladores de aplicaciones

Desarrollador de aplicaciones: comprar suscripciones a productos de API mediante la API

Nota: Un desarrollador de aplicaciones solo puede comprar una suscripción a un producto de API una vez. El desarrollador de la aplicación solo podrá comprar otra suscripción al mismo producto de API cuando caduque la suscripción.

Para comprar 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

Configura la solicitud de suscripción al producto de API. Para ello, incluye los campos obligatorios en el cuerpo de la solicitud, tal como se describe en Recurso: Suscripciones.

Por ejemplo, la siguiente llamada a la API 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"}'

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación se muestra un ejemplo de la salida de la respuesta. startTime está configurado para la hora actual.

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

Para obtener más información, consulte la API de suscripciones de productos de la API Purchase.

Desarrollador de aplicaciones: caducar inmediatamente una suscripción a un producto de API

Para que una suscripción a un producto de API caduque inmediatamente, 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 al producto de API con el nombre 69f8bb42-a8e4-4a2c-b932-d82b51d37b72 del 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"

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación se muestra un ejemplo de la salida de la respuesta. endTime está configurado para la hora actual.

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

Desarrollador de aplicaciones: mostrar todas las suscripciones a productos de API de un desarrollador

Para mostrar todas las suscripciones a productos de API de un desarrollador, envía una solicitud GET a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/developers/$DEVELOPER_EMAIL/subscriptions

También puede enviar los siguientes campos para admitir la paginación:

• startKey para especificar el nombre de la suscripción al producto de la API desde la que se debe empezar a mostrar la lista de suscripciones. Si se omite, la lista empieza por el primer elemento. Úsalo con count para filtrar de forma más específica. Por ejemplo, para ver las suscripciones de productos de la API del 51 al 150, asigne el nombre de la suscripción 51 al valor de startKey y el valor 100 a count.
• count para especificar el número de planes de tarifas que se devolverán en la llamada a la API. Úsalo con startKey para filtrar de forma más específica. El límite máximo es 1000. El valor predeterminado es 100.

Por ejemplo, la siguiente llamada a la API muestra todas las suscripciones a productos de API del desarrollador especificado:

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

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación, se muestra un ejemplo de la salida 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 List API product subscriptions.

Desarrollador de aplicaciones: ver los detalles de una suscripción a un producto de API

Para ver los detalles de la suscripción a un producto de API de 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, la siguiente llamada a la API obtiene detalles sobre una suscripción a un producto de API del 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"

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación, se muestra un ejemplo de la salida 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 Get API product subscription.

Gestión de suscripciones de AppGroup

En esta sección se proporcionan ejemplos para gestionar las suscripciones a productos de API de AppGroups. Para obtener más información sobre las APIs que se usan para gestionar las suscripciones de AppGroup, consulta Resource: Subscriptions (Recurso: Suscripciones).

AppGroup: comprar suscripciones a productos de API mediante la API

Nota: Un AppGroup solo puede comprar una suscripción a un producto de API una vez. El AppGroup solo podrá comprar otra suscripción al mismo producto de API cuando caduque la suscripción anterior.

Consulta Usar AppGroups para gestionar suscripciones a productos de API para obtener información sobre los requisitos para usar AppGroups con suscripciones a productos de API.

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

Configura la solicitud de suscripción al producto de API. Para ello, incluye los campos obligatorios en el cuerpo de la solicitud, tal como se describe en Resource: Subscriptions (Recurso: Suscripciones).

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

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación se muestra un ejemplo de la salida de la respuesta. startTime está configurado para la hora actual.

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

Para obtener más información, consulte la API de suscripciones de productos de la API Purchase.

AppGroup: Expire an API product subscription immediately

Para que una suscripción a un producto de API caduque inmediatamente, envía una solicitud POST a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions/$SUBSCRIPTION:expire

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

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación se muestra un ejemplo de la salida de la respuesta. endTime está configurado para la hora actual.

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

AppGroup: List all API product subscriptions

Para enumerar todas las suscripciones a productos de API de un AppGroup, envía una solicitud GET a la siguiente API: https://apigee.googleapis.com/v1/organizations/$ORG/appgroups/APPGROUP_ID/subscriptions

También puede enviar los siguientes campos para admitir la paginación:

• startKey para especificar el nombre de la suscripción al producto de la API desde la que se debe empezar a mostrar la lista de suscripciones. Si se omite, la lista empieza por el primer elemento. Úsalo con count para filtrar de forma más específica. Por ejemplo, para ver las suscripciones de productos de la API del 51 al 150, asigne el nombre de la suscripción 51 al valor de startKey y el valor 100 a count.
• count para especificar el número de planes de tarifas que se devolverán en la llamada a la API. Úsalo con startKey para filtrar de forma más específica. El límite máximo es 1000. El valor predeterminado es 100.

Por ejemplo, la siguiente llamada a la API muestra todas las suscripciones a productos de API del AppGroup especificado:

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

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación, se muestra un ejemplo de la salida de la respuesta:

{
  "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 obtener más información, consulta la API List API product subscriptions.

AppGroup: consulta los detalles de una suscripción a un producto de API.

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

Por ejemplo, la siguiente llamada a la API muestra información sobre una suscripción a un producto de API de un AppGroup específico:

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

Donde $TOKEN es tu token de acceso OAuth 2.0, tal como se describe en Obtener un token de acceso OAuth 2.0. Para obtener información sobre las opciones de curl que se usan en este ejemplo, consulta Usar curl. Para ver una descripción de las variables de entorno que puedes usar, consulta Definir variables de entorno para solicitudes a la API de Apigee.

A continuación, se muestra un ejemplo de la salida 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 Get API product subscription.