Estás viendo la documentación de Apigee Edge.
Ve a la
Documentación de Apigee X. información
La monetización ofrece un conjunto de APIs que puedes usar para anular la suspensión de un desarrollador que suspendida previamente, tal como se describe en las siguientes secciones. Un desarrollador puede ser suspendido si un se alcanza el límite configurado. Por ejemplo, la cantidad de transacciones alcanzó su máximo o se agotó el saldo prepagado de una cuenta. Para obtener una lista completa de los códigos de motivo, consulta Resumen de los 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 a lo siguiente
recurso: /organizations/{org_name}/suspended-developers
.
Aquí:
{org_name}
especifica el nombre de la organización.
Por ejemplo, la siguiente llamada cURL enumera todos los desarrolladores suspendidos por
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 muestra 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 a un desarrollador suspendido mediante la API
Para ver un desarrollador suspendido de una organización, envía una solicitud GET a lo 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 Desarrolladores.
Por ejemplo, la siguiente llamada cURL incluye 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 muestra 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" } ]
Anular la suspensión de todos los desarrolladores de un producto de API mediante la API
Anular la suspensión de todos los desarrolladores que fueron suspendidos por un producto de API mediante el envío de una solicitud POST
al siguiente recurso:
/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
Aquí:
{org_name}
especifica el nombre de la organización.{suspendedProduct_id}
especifica el ID del producto de API con un formato. similar al siguiente:{org_id}@@@{product_id}
. Este valor se devuelve comoprodId
cuando consultes todos los desarrolladores suspendidos o a determinados desarrolladores, como se describe en Cómo ver a todos los desarrolladores suspendidos que usan la API y Cómo ver a un desarrollador suspendido mediante la API.
Por ejemplo, la siguiente llamada 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
Anula la suspensión de un desarrollador con la API
Anular la suspensión de un desarrollador específico mediante el envío de una solicitud DELETE al siguiente recurso: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Aquí:
{org_name}
especifica el nombre de la organización.{suspendedDev_id}
especifica el ID del desarrollador suspendido en un formato similar al siguiente:{org_id}@@@{dev_id}
. Este valor se devuelve comodevId
cuando consultes a todos los desarrolladores suspendidos o a desarrolladores suspendidos específicos, tal como se describe en Cómo ver todos los desarrolladores suspendidos que usan la API y Cómo ver a un desarrollador suspendido mediante la API.
De manera opcional, puedes pasar el siguiente parámetro de consulta:
Parámetro de consulta | Descripción |
---|---|
suspendedProduct_id |
ID del producto de API, con un formato similar al siguiente:
{org_id}@@@{product_id} Este valor se muestra como prodId cuando
consultar a todos los desarrolladores suspendidos o a desarrolladores suspendidos específicos, tal como se describe en Cómo ver a todos los desarrolladores suspendidos que usan la API y Cómo ver a un desarrollador suspendido mediante la API. |
Por ejemplo, la siguiente llamada 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
La siguiente tabla resume los códigos de motivo que indican por qué un desarrollador ha sido suspendida.
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ó (se suscribió) un plan de tarifas. |
RATE_PLAN_RATE_BAND_EXCEEDED |
Se alcanzó el límite configurado para la banda de volumen final. |