Gérer les conditions d'utilisation

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Introduction

Vous devez ajouter des conditions d'utilisation ("Conditions d'utilisation") au profil de votre organisation avant de publier un plan tarifaire. Les conditions d'utilisation résident en dehors de l'organisation. profil. Dans le profil de votre organisation, vous spécifiez l'emplacement (URL publique) Conditions d'utilisation

Après la publication d'un plan tarifaire, la version actuelle des conditions d'utilisation s'affiche dans le portail des développeurs. Les développeurs ne peuvent souscrire un forfait qu'après avoir accepté le forfait actuel Conditions d'utilisation

Ajouter des termes et conditions à l'aide de l'interface utilisateur

1. Accédez à la page "Profil de l'organisation", comme décrit dans la section Explorer la page "Profil de l'organisation".
2. Cliquez sur Modifier.
3. Dans la section "Conditions d'utilisation" de la page "Profil de l'organisation", cliquez sur Ajouter des conditions d'utilisation conditions d'utilisation.

   La boîte de dialogue "Nouvelles conditions d'utilisation" s'affiche.

4. Saisissez les informations suivantes :

   Champ	Description
   Date d'entrée en vigueur	Date d'entrée en vigueur des conditions d'utilisation. La valeur par défaut est la valeur la date de début. Vous devez saisir la date actuelle ou une date ultérieure.
   Version	Version des conditions d'utilisation. Le numéro de version vous permet de conserver les différentes versions des conditions d'utilisation.
   URL	URL des conditions d'utilisation.

5. Cliquez sur Créer.

   Les nouvelles conditions d'utilisation sont ajoutées à la section "Conditions d'utilisation" du profil de l'organisation .

6. Répétez les étapes 3 à 5 pour ajouter d'autres conditions d'utilisation.
7. Cliquez sur Enregistrer pour enregistrer les modifications apportées au profil de l'organisation.

Modification des termes et conditions à l'aide de l'interface utilisateur

Vous ne pouvez pas modifier les conditions d'utilisation directement. Vous devez supprimer les termes et conditions que vous souhaitez modifier, puis ajoutez une nouvelle entrée de conditions d'utilisation.

Supprimer des termes et conditions à l'aide de l'interface utilisateur

1. Accédez à la page "Profil de l'organisation", comme décrit dans la section Explorer la page "Profil de l'organisation".
2. Cliquez sur Modifier sur la page "Profil de l'organisation".
3. Dans la liste des conditions d'utilisation, placez le curseur sur les conditions d'utilisation que vous souhaitez supprimer.
4. Cliquez sur .

Gestion des conditions d'utilisation à l'aide de l'API

Gérez les conditions d'utilisation à l'aide de l'API, comme décrit dans les sections suivantes.

Ajouter des termes et conditions à l'aide d'une API

Ajoutez les conditions d'utilisation en envoyant une requête POST à /mint/organizations/{org_name}/tncs. Lorsque vous ajoutez les conditions d'utilisation, vous pouvez éventuellement spécifier les éléments suivants:

• URL
• Texte d'accompagnement (une description, par exemple)
• Date d'entrée en vigueur des conditions d'utilisation
• Numéro de version

Pour en savoir plus, consultez Propriétés de configuration des conditions d'utilisation. des informations sur ces options.

Exemple :

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

Voici un exemple de réponse :

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

Afficher les termes et conditions à l'aide de l'API

Afficher les conditions d'utilisation spécifiques ou toutes les conditions d'utilisation d'une organisation.

Voir les en envoyant une demande GET à /mint/organizations/{org_name}/tncs/{tncs_id}, où {tncs_id} est l'identification des conditions d'utilisation spécifiques (l'identifiant est renvoyé dans le lors de la création des conditions d'utilisation). Exemple :

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

Affichez toutes les conditions d'utilisation de l'organisation en envoyant une demande GET à /mint/organizations/{org_name}/tncs Exemple :

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
  -H "Accept: application/json" \
  -u email:password

Voici un exemple de réponse :

{

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

Acceptation d'un document des conditions d'utilisation pour un développeur ou une entreprise utilisant l'API

Accepter les conditions d'utilisation d'un développeur ou d'une entreprise spécifique en envoyant une requête POST à l'une des API suivantes, respectivement:

• /mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs
• /mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs

Où {dev_id} correspond à l'ID de développeur (adresse e-mail), {company_id} à l'ID de l'entreprise et {tncs_id} à l'ID du document des conditions d'utilisation.

Exemple :

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

Voici un exemple de réponse :

{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

Afficher les conditions d'utilisation acceptées par un développeur ou une entreprise à l'aide de l'API

Affichez les conditions d'utilisation acceptées par un développeur ou une entreprise spécifique en émettant une requête GET. à l'une des API suivantes, respectivement:

• /mint/organizations/{org_name}/developers/{dev_id}/developer-tncs
• /mint/organizations/{org_name}/companies/{company_id}/developer-tncs

Où {dev_id} correspond à l'ID du développeur (adresse e-mail) et {company_id} à l'ID de l'entreprise.

Exemple :

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

Voici un exemple de réponse :

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

Modification des termes et conditions à l'aide de l'API

Modifiez les conditions d'utilisation en envoyant une requête PUT à /mint/organizations/{org_named}/tncs/{tncs_id}, où {tncs_id} correspond au et l'identification des conditions d'utilisation. Lorsque vous effectuez la mise à jour, vous devez spécifier dans la requête les paramètres mis à jour et l'identification des conditions d'utilisation. Par exemple : modifie le numéro de version des conditions d'utilisation (la propriété mise à jour est mise en évidence dans la exemple):

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

Voici un exemple de réponse :

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

Supprimer des termes et conditions à l'aide de l'API

Supprimer les conditions d'utilisation en envoyant une requête DELETE à /mint/organizations/{org_name}/tncs/{tncs_id}, où {tncs_id} correspond au et l'identification des conditions d'utilisation. Exemple :

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

Propriétés de configuration des conditions d'utilisation pour l'API

Le tableau suivant récapitule les propriétés de configuration pouvant être définies à l'aide de l'API pour les conditions d'utilisation.

Étapes suivantes

Découvrez comment ajouter des devises acceptées à celles initialement configurées pour votre organisation dans Gérer les appareils compatibles devises.