Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. info
La monetizzazione fornisce un insieme di API che puoi utilizzare per annullare la sospensione di uno sviluppatore precedentemente sospeso, come descritto nelle sezioni seguenti. Uno sviluppatore potrebbe essere sospeso se viene raggiunto un limite configurato. Ad esempio, il numero di transazioni ha raggiunto il limite massimo o il saldo di un account prepagato è stato esaurito. Per un elenco completo dei codici del motivo, consulta Riepilogo dei codici di motivo per gli sviluppatori sospesi.
Visualizzazione di tutti gli sviluppatori sospesi che utilizzano l'API
Visualizza tutti gli sviluppatori sospesi di un'organizzazione inviando una richiesta GET alla seguente
risorsa: /organizations/{org_name}/suspended-developers
.
Dove:
{org_name}
specifica il nome dell'organizzazione.
Ad esempio, la seguente chiamata cURL elenca tutti gli sviluppatori sospesi per
myorg
:
curl -H "Content-Type: application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/suspended-developers" \ -u email:password
Di seguito è riportato un esempio di risposta:
[ { "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" } ].
Visualizzazione di uno sviluppatore sospeso utilizzando l'API
Per visualizzare uno sviluppatore sospeso per un'organizzazione, invia una richiesta GET alla seguente
risorsa:
/organizations/{org_name}/suspended-developers/{developer_email_or_id}
.
Dove:
{org_name}
specifica il nome dell'organizzazione.{developer_email_or_id}
specifica l'ID dello sviluppatore. Per visualizzare un elenco di sviluppatori, consulta Elenca sviluppatori.
Ad esempio, la seguente chiamata cURL elenca i dettagli dello sviluppatore sospeso
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
Di seguito è riportato un esempio di risposta:
[ { "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" } ].
Annullamento della sospensione di tutti gli sviluppatori per un prodotto API che utilizza l'API
Annulla la sospensione di tutti gli sviluppatori sospesi per un prodotto API inviando una richiesta POST alla seguente risorsa:
/organizations/{org_name}/suspended-developers/unsuspend-by-product/{suspendedProduct_id}
.
Dove:
{org_name}
specifica il nome dell'organizzazione.{suspendedProduct_id}
specifica l'ID del prodotto API, utilizzando un formato simile al seguente:{org_id}@@@{product_id}
. Questo valore viene restituito comeprodId
quando visualizzi tutti gli sviluppatori sospesi o sviluppatori specifici, come descritto in Visualizzare tutti gli sviluppatori sospesi utilizzando l'API e Visualizzare uno sviluppatore sospeso utilizzando l'API.
Ad esempio, la seguente chiamata cURL annulla la sospensione di tutti gli sviluppatori per il prodotto 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
Annullamento della sospensione di uno sviluppatore che utilizza l'API
Annullare la sospensione di uno sviluppatore specifico che è stato sospeso inviando una richiesta DELETE alla seguente risorsa: /organizations/{org_name}/suspended-developers/{suspendedDev_id}.
Dove:
{org_name}
specifica il nome dell'organizzazione.{suspendedDev_id}
specifica l'ID dello sviluppatore sospeso, utilizzando un formato simile al seguente:{org_id}@@@{dev_id}
. Questo valore viene restituito comedevId
quando visualizzi tutti gli sviluppatori sospesi o sviluppatori specifici, come descritto in Visualizzare tutti gli sviluppatori sospesi utilizzando l'API e Visualizzare uno sviluppatore sospeso utilizzando l'API.
Se vuoi, puoi passare il seguente parametro di query:
Parametro di ricerca | Descrizione |
---|---|
suspendedProduct_id |
ID del prodotto API, utilizzando un formato simile al seguente:
{org_id}@@@{product_id} . Questo valore viene restituito come prodId quando
visualizzi tutti gli sviluppatori sospesi o solo alcuni specifici, come descritto in Visualizzazione di tutti gli sviluppatori sospesi utilizzando l'API e Visualizzazione di uno sviluppatore sospeso utilizzando l'API. |
Ad esempio, la seguente chiamata cURL annulla la sospensione dello sviluppatore con ID
myorg@@@6Vro7VnjUhpGVn3p
per il prodotto 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
Riepilogo dei codici del motivo per gli sviluppatori sospesi
La seguente tabella riassume i codici motivo che indicano il motivo per cui lo sviluppatore è stato sospeso.
Codice motivo | Descrizione |
---|---|
INSUFFICIENT_FUNDS |
L'account sviluppatore è stato esaurito. |
LIMIT_VIOLATED |
È stato raggiunto il limite configurato per l'account sviluppatore. |
NO_CURRENT_PUBLISHABLE_ENTITY |
Lo sviluppatore non ha accettato (sottoscritto) un piano tariffario. |
RATE_PLAN_RATE_BAND_EXCEEDED |
È stato raggiunto il limite configurato della banda di volume finale. |