Anular la suspensión de los desarrolladores

Estás viendo la documentación de Apigee Edge.
Ve a la documentación de Apigee X. info

La monetización proporciona un conjunto de APIs que puedes usar para restablecer la suspensión de un desarrollador que se suspendió anteriormente, como se describe en las siguientes secciones. Es posible que se suspenda a un desarrollador si se alcanza un límite configurado. Por ejemplo, la cantidad de transacciones alcanzó su límite máximo o se agotó el saldo de una cuenta prepagada. Para obtener una lista completa de los códigos de motivo, consulta el Resumen de códigos de motivo para desarrolladores suspendidos.

Cómo ver todos los desarrolladores suspendidos que usan la API

Para ver todos los desarrolladores suspendidos de una organización, envía una solicitud GET al siguiente recurso: /organizations/{org_name}/suspended-developers.

Aquí:

  • {org_name} especifica el nombre de la organización.

Por ejemplo, en la siguiente llamada a cURL, se enumeran todos los desarrolladores suspendidos para myorg:

curl -H "Content-Type: application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \
-u email:password

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

[
  {
    "creationDate": 1464388723633,
    "devId": "myorg@@@6Vro7VnjUhpGVn3p",
    "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED",
    "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED",
    "orgId": "myorg",
    "prodId": "myorg@@@myproduct",
    "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED"
  },
  {
    "creationDate": 1464022846293,
    "devId": "myorg@@@vXh7LXxtUy9COVdy",
    "id": "myorg-myorg@@@vXh7LXxtUy9COVdy-myorg@@@myproduct-null-NO_CURRENT_PUBLISHABLE_ENTITY",
    "message": "mint.productHasBeenSuspended for myorg@@@vXh7LXxtUy9COVdy myorg@@@myproduct due to mint.noCurrentPublishableEntity",
    "orgId": "myorg",
    "prodId": "myorg@@@myproduct",
    "reasonCode": "NO_CURRENT_PUBLISHABLE_ENTITY"
  }
]

Cómo ver un desarrollador suspendido con la API

Para ver un desarrollador suspendido de una organización, envía una solicitud GET al siguiente recurso: /organizations/{org_name}/suspended-developers/{developer_email_or_id}.

Aquí:

  • {org_name} especifica el nombre de la organización.
  • {developer_email_or_id} especifica el ID del desarrollador. Para ver una lista de desarrolladores, consulta Lista de desarrolladores.

Por ejemplo, en la siguiente llamada a cURL, se enumeran los detalles del desarrollador suspendido joe@example.com:

curl -H "Content-Type: application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/joe@example.com" \
-u email:password

A continuación, se proporciona una respuesta de ejemplo:

[
  {
    "creationDate": 1464388723633,
    "devId": "myorg@@@6Vro7VnjUhpGVn3p",
    "id": "myorg-myorg@@@6Vro7VnjUhpGVn3p-myorg@@@myproduct-null-RATE_PLAN_RATE_BAND_EXCEEDED",
    "message": "mint.productHasBeenSuspended for myorg@@@6Vro7VnjUhpGVn3p myorg@@@myproduct due to RATE_PLAN_RATE_BAND_EXCEEDED",
    "orgId": "myorg",
    "prodId": "myorg@@@myproduct",
    "reasonCode": "RATE_PLAN_RATE_BAND_EXCEEDED"
  }
]

Cómo anular la suspensión de todos los desarrolladores de un producto de API con la API

Para restablecer la suspensión de todos los desarrolladores que se suspendieron por un producto de API, envía una solicitud POST al siguiente recurso: /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}.

Aquí:

Por ejemplo, la siguiente llamada a cURL anula la suspensión de todos los desarrolladores del producto de API myorg@@@myproduct:

curl -H "Content-Type: application/json" -X POST \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/unsuspend-by-product/myorg@@@myproduct" \
-u email:password

Cómo anular la suspensión de un desarrollador con la API

Para anular la suspensión de un desarrollador específico, envía una solicitud DELETE al siguiente recurso: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.

Aquí:

De manera opcional, puedes pasar el siguiente parámetro de consulta:

Parámetro de consulta Descripción
suspendedProduct_id El ID del producto de la API, con un formato similar al siguiente: {org_id}@@@{product_id}. Este valor se muestra como prodId cuando ves a todos los desarrolladores suspendidos o a desarrolladores específicos, como se describe en Cómo ver a todos los desarrolladores suspendidos con la API y Cómo ver a un desarrollador suspendido con la API.

Por ejemplo, la siguiente llamada a cURL anula la suspensión del desarrollador con el ID myorg@@@6Vro7VnjUhpGVn3p para el producto de API myorg@@@myproduct:

curl -H "Content-Type: application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers/myorg@@@6Vro7VnjUhpGVn3p?productId=myorg@@@myproduct" \
-u email:password

Resumen de los códigos de motivo para desarrolladores suspendidos

En la siguiente tabla, se resumen los códigos de motivo que indican por qué se suspendió a un desarrollador.

Código del motivo Descripción
INSUFFICIENT_FUNDS Se agotó la cuenta de desarrollador.
LIMIT_VIOLATED Se alcanzó el límite configurado para la cuenta de desarrollador.
NO_CURRENT_PUBLISHABLE_ENTITY El desarrollador no aceptó (no se suscribió) a un plan de tarifas.
RATE_PLAN_RATE_BAND_EXCEEDED Se alcanzó el límite configurado de la banda de volumen final.