Anular la suspensión de los desarrolladores

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

La monetización proporciona un conjunto de APIs que puedes usar para reactivar a un desarrollador que se suspendió anteriormente, como se describe en las siguientes secciones. Un desarrollador puede suspenderse 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 prepaga. Para obtener una lista completa de los códigos de motivo, consulta Resumen de los códigos de motivo para desarrolladores suspendidos.

Visualiza todos los desarrolladores suspendidos con la API

Visualiza todos los desarrolladores suspendidos de una organización enviando una solicitud GET al siguiente recurso: /organizations/{org_name}/suspended-developers.

Donde:

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

Por ejemplo, en la siguiente llamada a cURL, se enumeran todos los desarrolladores suspendidos de 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 la 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"
  }
]

Visualiza un desarrollador suspendido con la API

Visualiza un desarrollador suspendido de una organización enviando una solicitud GET al siguiente recurso: /organizations/{org_name}/suspended-developers/{developer_email_or_id}.

Donde:

• {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 Enumera 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 un ejemplo de la 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"
  }
]

Reactiva a todos los desarrolladores de un producto de API con la API

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

Donde:

• {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 muestra como prodId cuando visualizas todos los desarrolladores suspendidos o algunos específicos, como se describe en Visualiza todos los desarrolladores suspendidos con la API y Visualiza un desarrollador suspendido con la API.

Por ejemplo, en la siguiente llamada a cURL, se reactivan 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

Reactiva a un desarrollador con la API

Para reactivar a un desarrollador específico que se suspendió, envía una solicitud DELETE al siguiente recurso: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.

Donde:

• {org_name} especifica el nombre de la organización.
• {suspendedDev_id} especifica el ID del desarrollador suspendido, con un formato similar al siguiente: {org_id}@@@{dev_id}. Este valor se muestra como devId cuando visualizas todos los desarrolladores suspendidos o algunos específicos, como se describe en Visualiza todos los desarrolladores suspendidos con la API y Visualiza un desarrollador suspendido con la API.

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

Por ejemplo, en la siguiente llamada a cURL, se reactiva el 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.