Réactiver les développeurs

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

La monétisation fournit un ensemble d'API que vous pouvez utiliser pour réactiver un développeur précédemment suspendu, comme décrit dans les sections suivantes. Un développeur peut être suspendu si une limite configurée est atteinte. Par exemple, le nombre de transactions a atteint sa limite maximale ou le solde d'un compte prépayé est épuisé. Pour obtenir la liste complète des codes de motifs, consultez la section Récapitulatif des codes de motifs pour les développeurs suspendus.

Afficher tous les développeurs suspendus à l'aide de l'API

Affichez tous les développeurs suspendus pour une organisation en envoyant une requête GET à la ressource suivante: /organizations/{org_name}/suspended-developers.

Où :

  • {org_name} spécifie le nom de l'organisation.

Par exemple, l'appel cURL suivant répertorie tous les développeurs suspendus pour myorg:

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

Voici un exemple de réponse:

[
  {
    "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"
  }
]
.

Afficher un développeur suspendu à l'aide de l'API

Pour afficher un développeur suspendu pour une organisation, envoyez une requête GET à la ressource suivante : /organizations/{org_name}/suspended-developers/{developer_email_or_id}.

Où :

  • {org_name} spécifie le nom de l'organisation.
  • {developer_email_or_id} spécifie l'ID du développeur. Pour afficher la liste des développeurs, consultez Répertorier les développeurs.

Par exemple, l'appel cURL suivant répertorie les détails du développeur joe@example.com suspendu:

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

Voici un exemple de réponse:

[
  {
    "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"
  }
]
.

Annulation de la suspension de tous les développeurs d'un produit d'API à l'aide de l'API

Pour réactiver tous les développeurs qui ont été suspendus pour un produit d'API, envoyez une requête POST à la ressource suivante : /organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}.

Où :

Par exemple, l'appel cURL suivant annule la suspension de tous les développeurs pour le produit d'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

Réactiver un développeur à l'aide de l'API

Pour réactiver un développeur spécifique qui a été suspendu, envoyez une requête DELETE à la ressource suivante: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.

Où :

Vous pouvez éventuellement transmettre le paramètre de requête suivant:

Paramètre de requête Description
suspendedProduct_id ID du produit d'API, au format semblable à celui-ci : {org_id}@@@{product_id}. Cette valeur est renvoyée sous la forme prodId lorsque vous affichez tous les développeurs suspendus ou seulement certains, comme décrit dans les sections Afficher tous les développeurs suspendus à l'aide de l'API et Afficher un développeur suspendu à l'aide de l'API.

Par exemple, l'appel cURL suivant annule la suspension du développeur avec l'ID myorg@@@6Vro7VnjUhpGVn3p pour le produit d'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

Récapitulatif des codes de motifs pour les développeurs suspendus

Le tableau suivant récapitule les codes de motifs indiquant pourquoi un développeur a été suspendu.

Code de motif Description
INSUFFICIENT_FUNDS Le compte de développeur est épuisé.
LIMIT_VIOLATED La limite configurée pour le compte de développeur a été atteinte.
NO_CURRENT_PUBLISHABLE_ENTITY Le développeur n'a pas accepté un plan tarifaire (c'est-à-dire qu'il n'y est pas abonné).
RATE_PLAN_RATE_BAND_EXCEEDED La limite configurée pour la bande de volume finale a été atteinte.