Cancelar a suspensão de desenvolvedores

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

A monetização oferece um conjunto de APIs que podem ser usadas para suspender um desenvolvedor que foi suspenso anteriormente, conforme descrito nas seções a seguir. Um desenvolvedor pode 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 uma lista completa de códigos de motivo, consulte o Resumo dos códigos de motivo para desenvolvedores suspensos.

Como conferir todos os desenvolvedores suspensos usando a API

Veja todos os desenvolvedores suspensos de uma organização emitindo 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 a seguir lista todos os desenvolvedores suspensos para 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 conferir um desenvolvedor suspenso usando a API

Veja um desenvolvedor suspenso em uma organização emitindo 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 conferir uma lista de desenvolvedores, consulte Listar desenvolvedores.

Por exemplo, a chamada de cURL a seguir lista detalhes do desenvolvedor joe@example.com suspenso:

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 abaixo 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"
  }
]

Como suspender todos os desenvolvedores de um produto de API usando a API

Cancele a suspensão de todos os desenvolvedores suspensos por 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:

Por exemplo, a chamada de cURL a seguir desativa 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 suspender um desenvolvedor usando a API

Para reativar um desenvolvedor específico que foi suspenso, emita uma solicitação DELETE para o seguinte recurso: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.

Em que:

Você também pode passar o seguinte parâmetro de consulta:

Parâmetro de consulta Descrição
suspendedProduct_id ID do produto da API, usando um formato semelhante ao seguinte: {org_id}@@@{product_id}. Esse valor é retornado como prodId quando você vê todos os desenvolvedores suspensos ou apenas alguns, conforme descrito em Como conferir todos os desenvolvedores suspensos usando a API e Como ver um desenvolvedor suspenso usando a API.

Por exemplo, a chamada de cURL a seguir desativa 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 por que um desenvolvedor foi suspenso.

Código de 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 preços.
RATE_PLAN_RATE_BAND_EXCEEDED O limite configurado da faixa de volume final foi atingido.