Gestisci termini e condizioni

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Introduzione

Prima di pubblicare un piano tariffario, devi aggiungere i Termini e condizioni ("T&C") al profilo della tua organizzazione. I Termini e condizioni si trovano al di fuori del profilo dell'organizzazione. Nel profilo dell'organizzazione, devi specificare la posizione (URL pubblico) dei Termini e condizioni.

Dopo aver pubblicato un piano tariffario, nel portale per sviluppatori viene visualizzata la versione corrente dei Termini e condizioni. Gli sviluppatori possono acquistare un piano solo dopo aver accettato i Termini e condizioni correnti.

Aggiungere i Termini e condizioni utilizzando l'interfaccia utente

  1. Accedi alla pagina Profilo dell'organizzazione, come descritto in Esplorare la 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. Inserisci le seguenti informazioni:
    Campo Descrizione
    Data di validità

    Data di entrata in vigore dei Termini e condizioni. Il valore predefinito è la data corrente data. Devi inserire la data corrente 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 Profilo dell'organizzazione pagina.

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

Modificare i Termini e condizioni utilizzando l'interfaccia utente

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

Eliminare i Termini e condizioni utilizzando l'interfaccia utente

  1. Accedi alla pagina Profilo dell'organizzazione, come descritto in Esplorare la 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 vuoi eliminare.
  4. Fai clic su .

Gestire i Termini e condizioni utilizzando l'API

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

Aggiungere i Termini e condizioni utilizzando un'API

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

  • URL
  • Testo di accompagnamento (ad esempio una descrizione)
  • Data di entrata in vigore dei Termini e condizioni
  • 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 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

Visualizza 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 dei Termini e condizioni specifici (l'ID viene restituito nella risposta quando crei i 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 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 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 dei Termini e condizioni per uno sviluppatore o un'azienda utilizzando l'API

Accetta un documento dei Termini e condizioni per uno sviluppatore o un'azienda specifica 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 dei 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:

Nota: nel payload della risposta, il 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",
      ...
  }
}

Visualizzare i Termini e condizioni accettati da uno sviluppatore o un'azienda utilizzando l'API

Visualizza i Termini e condizioni accettati da uno sviluppatore o un'azienda specifica 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 i 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 i Termini e condizioni utilizzando l'API

Elimina i 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 dei Termini e condizioni per l'API

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

Nome Descrizione Predefinito Obbligatorio?
url

URL dei Termini e condizioni.

 N/D No
tncText

Testo (ad esempio una breve descrizione) per i Termini e condizioni.

 N/D No
version

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

 N/D Sì
startDate

Data di entrata in vigore dei Termini e condizioni.

 N/D Sì
organization

Organizzazione per i Termini e condizioni.

 N/D No

Passaggi successivi

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