Você está vendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. informações
A monetização oferece um conjunto de APIs que podem ser usadas para cancelar a suspensão de um desenvolvedor que foi suspenso anteriormente, conforme descrito nas seções a seguir. O desenvolvedor poderá ser suspenso se um limite configurado for atingido. Por exemplo, o número de transações atingiu o limite máximo ou o saldo de uma conta pré-paga foi esgotado. Para ver uma lista completa de códigos de motivo, consulte a página Resumo de códigos de motivo para desenvolvedores suspensos.
Visualização de todos os desenvolvedores suspensos que usam a API
Confira todos os desenvolvedores suspensos de uma organização enviando uma solicitação GET para o seguinte
recurso: /organizations/{org_name}/suspended-developers
.
Em que:
{org_name}
especifica o nome da organização.
Por exemplo, a chamada de cURL abaixo lista todos os desenvolvedores suspensos de
myorg
:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Confira a seguir um exemplo de resposta:
[ { "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" } ]
Como visualizar um desenvolvedor suspenso usando a API
Confira um desenvolvedor suspenso de uma organização enviando uma solicitação GET para o seguinte
recurso:
/organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
Em que:
{org_name}
especifica o nome da organização.{developer_email_or_id}
especifica o ID do desenvolvedor. Para ver uma lista de desenvolvedores, consulte Listar desenvolvedores.
Por exemplo, a chamada de cURL a seguir lista detalhes do desenvolvedor suspenso
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
Confira a seguir um exemplo de resposta:
[ { "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" } ]
Cancelamento da suspensão de todos os desenvolvedores para um produto de API usando a API
Cancele a suspensão de todos os desenvolvedores que foram suspensos para um produto de API emitindo uma solicitação POST
para o seguinte recurso:
/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
Em que:
{org_name}
especifica o nome da organização.{suspendedProduct_id}
especifica o ID do produto da API, usando um formato semelhante ao seguinte:{org_id}@@@{product_id}
. Esse valor é retornado comoprodId
quando você visualiza todos ou apenas os desenvolvedores suspensos específicos, conforme descrito em Visualizar todos os desenvolvedores suspensos usando a API e Como visualizar um desenvolvedor suspenso usando a API.
Por exemplo, a chamada de cURL a seguir cancela a suspensão de todos os desenvolvedores do produto 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
Como cancelar a suspensão de um desenvolvedor usando a API
Cancelar a suspensão de um desenvolvedor específico que tenha sido suspenso emitindo uma solicitação DELETE para o seguinte recurso: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Em que:
{org_name}
especifica o nome da organização.{suspendedDev_id}
especifica o ID do desenvolvedor suspenso, usando um formato semelhante ao seguinte:{org_id}@@@{dev_id}
. Esse valor é retornado comodevId
quando você visualiza todos ou apenas os desenvolvedores suspensos específicos, conforme descrito em Visualizar todos os desenvolvedores suspensos usando a API e Como visualizar um desenvolvedor suspenso usando a API.
Também é possível transmitir o seguinte parâmetro de consulta:
Parâmetro de consulta | Descrição |
---|---|
suspendedProduct_id |
ID do produto de API, usando um formato semelhante ao seguinte:
{org_id}@@@{product_id} . Esse valor é retornado como prodId quando
você visualiza todos ou apenas desenvolvedores suspensos específicos, conforme descrito em Visualizar todos os desenvolvedores suspensos usando a API e Como visualizar um desenvolvedor suspenso usando a API. |
Por exemplo, a chamada de cURL a seguir cancela a suspensão do desenvolvedor com o ID
myorg@@@6Vro7VnjUhpGVn3p
para o produto 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
Resumo dos códigos de motivo para desenvolvedores suspensos
A tabela a seguir resume os códigos de motivo que indicam o motivo da suspensão de um desenvolvedor.
Código do motivo | Descrição |
---|---|
INSUFFICIENT_FUNDS |
A conta de desenvolvedor foi esgotada. |
LIMIT_VIOLATED |
O limite configurado para a conta de desenvolvedor foi atingido. |
NO_CURRENT_PUBLISHABLE_ENTITY |
O desenvolvedor não aceitou (assinou) um plano de tarifas. |
RATE_PLAN_RATE_BAND_EXCEEDED |
O limite configurado da banda de volume final foi atingido. |