Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Introduzione
Devi aggiungere termini e condizioni ("Termini e condizioni") al profilo della tua organizzazione prima di pubblicare un piano tariffario. Termini e condizioni risiedono al di fuori del profilo dell'organizzazione. Nel profilo della tua organizzazione, specifichi la località (URL pubblico) dei Termini e condizioni.
Dopo aver pubblicato un piano tariffario, la versione corrente dei Termini e condizioni viene visualizzata nel portale per gli sviluppatori. Gli sviluppatori possono acquistare un piano solo dopo aver accettato i Termini e condizioni attuali.
Aggiunta di termini e condizioni tramite l'interfaccia utente
- Accedi alla pagina del profilo dell'organizzazione, come descritto in Esplorazione della pagina del profilo dell'organizzazione.
- Fai clic su Modifica.
- Nella sezione Termini e condizioni della pagina Profilo dell'organizzazione, fai clic su Aggiungi termini e condizioni.
Viene visualizzata la finestra di dialogo Nuovi termini e condizioni
- Immetti le seguenti informazioni:
Campo Descrizione Data di validità Data di entrata in vigore dei termini e condizioni. L'impostazione predefinita è la data corrente. Devi inserire la data corrente o una data futura.
Versione Versione dei Termini e condizioni. Il numero di versione consente di tenere traccia delle diverse versioni dei Termini e condizioni.
URL URL dei Termini e condizioni.
- Fai clic su Crea.
I nuovi Termini e condizioni vengono aggiunti alla sezione Termini e condizioni della pagina del profilo dell'organizzazione.
- Ripeti i passaggi da 3 a 5 per aggiungere altri termini e condizioni.
- Fai clic su Salva per salvare le modifiche apportate al profilo dell'organizzazione.
Modifica di termini e condizioni mediante l'interfaccia utente
Non puoi modificare direttamente i Termini e condizioni. Devi eliminare i termini e condizioni da modificare e aggiungerne una nuova.
Eliminare termini e condizioni utilizzando l'interfaccia utente
- Accedi alla pagina del profilo dell'organizzazione, come descritto in Esplorazione della pagina del profilo dell'organizzazione.
- Fai clic su Modifica nella pagina del profilo dell'organizzazione.
- Nell'elenco di termini e condizioni, posiziona il cursore sui termini e condizioni che desideri eliminare.
- Fai clic su
.
Gestione di termini e condizioni mediante l'API
Gestisci termini e condizioni utilizzando l'API, come descritto nelle sezioni seguenti.
Aggiungere termini e condizioni utilizzando un'API
Aggiungi termini e condizioni inviando una richiesta POST a /mint/organizations/{org_name}/tncs.
Quando aggiungi termini e condizioni, puoi specificare facoltativamente:
- URL
- Testo di accompagnamento (ad es. una descrizione)
- Data di entrata in vigore di Termini e condizioni
- Numero di versione
Consulta le proprietà di configurazione di Termini e condizioni per ulteriori informazioni su queste opzioni.
Ad esempio:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Content-Type: application/json" \
-d \
'{
"url":"www.testoperator/termsandconditions",
"tncText":"Sample text for the T&C",
"version":"1.1",
"startDate":"2018-09-24"
}' \
-u email:password
Di seguito è riportato un esempio della risposta:
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
"organization" : {
…
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}
Visualizzare i termini e condizioni utilizzando l'API
Visualizzare termini e condizioni specifici o tutti i termini e condizioni di un'organizzazione.
Visualizza termini e condizioni specifici inviando una richiesta GET a /mint/organizations/{org_name}/tncs/{tncs_id}, dove {tncs_id} è l'identificazione di termini e condizioni specifici (l'ID viene restituito nella risposta al momento della creazione dei termini e condizioni). Ad esempio:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
-H "Accept: application/json" \
-u email:password
Visualizza tutti i Termini e condizioni per l'organizzazione inviando una richiesta GET a /mint/organizations/{org_name}/tncs. Ad esempio:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Accept: application/json" \
-u email:password
Di seguito è riportato un esempio della risposta:
{
"tnc" : [
{
"id" : "77193339-8d79-44a8-8af2-3593f16c158e",
"organization" :
{
...
},
"startDate" : "2018-07-01 00:00:00",
"tncText" : "Big operator text for the T&C",
"url" : "www.bigoperator/termsandconditions",
"version" : "1.0"
},
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
"organization" : {
...
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}
]
"totalRecords" : 2
}
Accettare un documento relativo a Termini e condizioni per uno sviluppatore o una società che utilizza l'API
Accetta un documento dei termini e condizioni per uno sviluppatore o un'azienda specifici inviando una richiesta POST a una delle seguenti API, rispettivamente:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
Dove {dev_id} è l'ID sviluppatore (indirizzo email), {company_id} è l'ID azienda e {tncs_id} è l'ID documento di Termini e condizioni.
Ad esempio:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
-H "Content-Type: application/json" \
-d \
'{
"action":"ACCEPTED",
"auditDate":"2018-10-01 00:00:00"
}' \
-u email:password
Di seguito è riportato un esempio della risposta:
auditDate è impostato sull'ora attuale in UTC.
{
"action": "ACCEPTED",
"auditDate": "2018-10-01 07:24:45",
"id": "dev2@myorg.com",
"tnc": {
"id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
...
}
}
Visualizzazione dei Termini e condizioni accettati da uno sviluppatore o da una società tramite l'API
Visualizza i Termini e condizioni accettati da uno sviluppatore o un'azienda specifici inviando una richiesta GET a una delle seguenti API, rispettivamente:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
Dove {dev_id} è l'ID sviluppatore (indirizzo email) e {company_id} è l'ID azienda.
Ad esempio:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
-H "Accept:application/json" \
-u email:password
Di seguito è riportato un esempio della risposta:
{
"developerTnc": [
{
"action": "ACCEPTED",
"auditDate": "2018-08-29 07:24:45",
"id": "dev2@myorg.com",
"tnc": {
"id": "26abc14c-c628-4c38-8840-a343c8ee9437",
...
}
}],
"totalRecords": 1
}
Modificare i termini e condizioni utilizzando l'API
Modifica termini e condizioni inviando una richiesta PUT a
/mint/organizations/{org_named}/tncs/{tncs_id}, dove {tncs_id} è
l'identificazione dei termini e condizioni. Quando esegui l'aggiornamento, devi specificare nel corpo della richiesta le impostazioni aggiornate e l'identificazione dei termini e condizioni. Ad esempio, la seguente richiesta modifica il numero di versione dei Termini e condizioni (la proprietà aggiornata è evidenziata nell'esempio):
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
-H "Content-Type: application/json" \
-d {
"id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
"version":"1.2"
}' \
-u email:password
Di seguito è riportato un esempio della risposta:
{
"id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9",
"organization" : {
"address" : [ {
"address1" : "Test address",
"city" : "Test City",
"country" : "US",
"id" : "test-address",
"isPrimary" : true,
"state" : "CA",
"zip" : "54321"
} ],
…"
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.2"
}
Eliminare termini e condizioni utilizzando l'API
Elimina termini e condizioni inviando una richiesta DELETE a /mint/organizations/{org_name}/tncs/{tncs_id}, dove {tncs_id} è l'identificazione dei termini e condizioni. Ad esempio:
curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \ -H "Accept: application/json" \ -u email:password
Proprietà di configurazione di Termini e condizioni per l'API
La tabella seguente riassume le proprietà di configurazione che possono essere impostate utilizzando l'API per termini e condizioni.
| Nome | Descrizione | Predefinito | Campo obbligatorio? |
|---|---|---|---|
url |
URL Termini e condizioni. |
N/A | No |
tncText |
Testo (ad esempio una breve descrizione) per i Termini e condizioni. |
N/A | No |
version |
Versione di Termini e condizioni. Il numero di versione consente di tenere traccia delle diverse versioni dei Termini e condizioni. |
N/A | Sì |
startDate |
Data di entrata in vigore di Termini e condizioni. |
N/A | Sì |
organization |
Organizzazione di Termini e condizioni. |
N/A | No |
Passaggi successivi
Scopri come aggiungere le valute supportate a quelle inizialmente configurate per la tua organizzazione nella pagina Gestire le valute supportate.