Gestisci termini e condizioni

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X.
informazioni

Introduzione

Devi aggiungere i termini e condizioni ("T&C") al profilo della tua organizzazione prima di pubblicare un piano tariffario. I TdC non si trovano nel profilo dell'organizzazione. Nel profilo della tua organizzazione, specifica la posizione (URL pubblico) dei Termini e condizioni.

Dopo aver pubblicato un piano tariffario, la versione corrente dei TdC viene visualizzata nel portale per gli sviluppatori. Gli sviluppatori possono acquistare un piano solo dopo aver accettato i TdS attuali.

Aggiunta di termini e condizioni utilizzando l'interfaccia utente

  1. Accedi alla pagina Profilo dell'organizzazione, come descritto in Esplorazione della pagina Profilo dell'organizzazione.
  2. Fai clic su Modifica.
  3. 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

  4. Immetti le seguenti informazioni:
    Campo Descrizione
    Data di validità

    Data di validità dei Termini e condizioni. Il valore predefinito è la data corrente. Devi inserire la data attuale o una data futura.

    Versione

    Versione dei Termini e condizioni. Il numero di versione ti consente di tenere traccia delle diverse versioni dei Termini e condizioni.

    URL

    URL dei Termini e condizioni.

  5. Fai clic su Crea.

    I nuovi Termini e condizioni vengono aggiunti alla sezione Termini e condizioni della pagina del profilo dell'organizzazione.

  6. Ripeti i passaggi da 3 a 5 per aggiungere altri termini e condizioni.
  7. Fai clic su Salva per salvare le modifiche al profilo dell'organizzazione.

Modificare i termini e le condizioni utilizzando l'interfaccia utente

Non puoi modificare direttamente i Termini e condizioni. Devi invece eliminare i termini e condizioni che vuoi modificare e aggiungere una nuova voce.

Eliminare i termini e le condizioni utilizzando l'interfaccia utente

  1. Accedi alla pagina Profilo dell'organizzazione, come descritto in Esplorazione della pagina Profilo dell'organizzazione.
  2. Fai clic su Modifica nella pagina Profilo dell'organizzazione.
  3. Nell'elenco dei Termini e condizioni, posiziona il cursore sui termini e condizioni che desideri eliminare.
  4. Fai clic su .

Gestione di termini e condizioni con l'API

Gestisci termini e condizioni utilizzando l'API, come descritto nelle sezioni seguenti.

Aggiunta di termini e condizioni tramite un'API

Aggiungi i TdS inviando una richiesta POST a /mint/organizations/{org_name}/tncs. Quando aggiungi i Termini e condizioni, puoi specificare se:

  • URL
  • Testo aggiuntivo (ad esempio una descrizione)
  • Data di validità dei TdC
  • Numero di versione

Per ulteriori informazioni su queste opzioni, consulta Proprietà di configurazione dei Termini e condizioni.

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 di 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"
 }

Visualizzazione di termini e condizioni utilizzando l'API

Visualizzare Termini e condizioni specifici o tutti i Termini e condizioni di un'organizzazione.

Visualizza condizioni generali di contratto specifiche inviando una richiesta GET a /mint/organizations/{org_name}/tncs/{tncs_id}, dove {tncs_id} è l'identificazione delle condizioni generali di contratto specifiche (l'ID viene restituito nella risposta quando crei le condizioni generali di contratto). 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 TdC dell'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 di 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 TdC 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 del documento relativo ai 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 di risposta:

Nota: nel payload della risposta, auditDate è impostato sull'ora corrente 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 un'azienda che utilizza l'API

Visualizza i TdC accettati da uno sviluppatore o da un'azienda specifici inviando una richiesta GET a una delle seguenti API:

  • /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 di risposta:

{
  "developerTnc": [
  {
    "action": "ACCEPTED",
    "auditDate": "2018-08-29 07:24:45",
    "id": "dev2@myorg.com",
    "tnc": {
      "id": "26abc14c-c628-4c38-8840-a343c8ee9437",
      ...
    }
  }],
  "totalRecords": 1
}

Modifica dei termini e delle condizioni utilizzando l'API

Modifica i TdC inviando una richiesta PUT a /mint/organizations/{org_named}/tncs/{tncs_id}, dove {tncs_id} è il valore di identificazione dei TdC. 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 TdC (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 viene fornito 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"
 }

Eliminazione di termini e condizioni utilizzando l'API

Elimina i TdC inviando una richiesta DELETE a /mint/organizations/{org_name}/tncs/{tncs_id}, dove {tncs_id} è il codice identificativo dei TdC. 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 dei Termini e condizioni per l'API

La seguente tabella riassume le proprietà di configurazione che possono essere impostate utilizzando l'API per i termini e le condizioni.

Nome Descrizione Predefinito Obbligatorio?
url

URL dei Termini e condizioni.

N/D No
tncText

Testo (ad esempio una breve descrizione) per i TdC.

N/D No
version

Versione dei Termini e condizioni. Il numero di versione consente di tenere traccia delle diverse versioni dei Termini e condizioni.

N/D
startDate

Data di entrata in vigore dei Termini e condizioni.

N/D
organization

Organizzazione per Termini e condizioni.

N/D No

Passaggi successivi

Scopri come aggiungere le valute supportate a quelle configurate inizialmente per la tua organizzazione in Gestire le valute supportate.