Réactiver les développeurs

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

La monétisation fournit un ensemble d'API que vous pouvez utiliser pour réactiver un compte de 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 la limite maximale ou le solde d'un compte prépayé a été épuisé. Pour obtenir la liste complète des codes de motif, consultez la section Récapitulatif des codes de motif 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 Liste des 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"
  }
]

Réactiver tous les développeurs pour un produit d'API à l'aide de l'API

Réactivez tous les développeurs suspendus pour un produit d'API en envoyant 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

Réactivez un développeur spécifique qui a été suspendu en envoyant 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, dans un 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 des développeurs suspendus spécifiques, comme décrit dans 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 réactive le 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ésumé des codes de motif pour les développeurs suspendus

Le tableau suivant récapitule les codes de motif qui indiquent pourquoi un développeur a été suspendu.

Code du motif Description
INSUFFICIENT_FUNDS Le compte de développeur a été épuisé.
LIMIT_VIOLATED Vous avez atteint la limite configurée pour votre compte de développeur.
NO_CURRENT_PUBLISHABLE_ENTITY Le développeur n'a pas accepté (ni souscrit) d'offre de chambres.
RATE_PLAN_RATE_BAND_EXCEEDED La limite configurée de la bande de volume finale a été atteinte.