Gérer les conditions d'utilisation

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Introduction

Vous devez ajouter des conditions d'utilisation à votre fiche d'organisation avant de publier un plan tarifaire. Les conditions d'utilisation se trouvent en dehors du profil de l'organisation. Dans le profil de votre organisation, vous devez spécifier l'emplacement (URL publique) des conditions d'utilisation.

Une fois que vous avez publié un plan tarifaire, la version actuelle des conditions d'utilisation s'affiche dans le portail pour les développeurs. Les développeurs ne peuvent souscrire un forfait qu'après avoir accepté les conditions d'utilisation en vigueur.

Ajouter des conditions d'utilisation à l'aide de l'interface utilisateur

  1. Accédez à la page "Profil de l'organisation", comme décrit dans 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.

    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 à laquelle les conditions d'utilisation sont en vigueur. La valeur par défaut est la date du jour. Vous devez saisir la date actuelle ou une date ultérieure.
    Version

    Version des conditions d'utilisation. Le numéro de version vous permet d'effectuer le suivi des 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" de la page "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 directement les conditions d'utilisation. Vous devez plutôt supprimer les conditions d'utilisation que vous souhaitez modifier, puis en ajouter de nouvelles.

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

  1. Accédez à la page "Profil de l'organisation", comme décrit dans 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 celles que vous souhaitez supprimer.
  4. Cliquez sur .

Gérer les 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 conditions d'utilisation à 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:

  • 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 sur ces options, consultez la section Propriétés de configuration des conditions d'utilisation.

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 conditions d'utilisation à l'aide de l'API

Afficher des conditions d'utilisation spécifiques ou l'ensemble des conditions d'utilisation d'une organisation

Affichez des conditions d'utilisation spécifiques en envoyant une requête GET à /mint/organizations/{org_name}/tncs/{tncs_id}, où {tncs_id} est l'identification des conditions d'utilisation spécifiques (l'ID est renvoyé dans la réponse lorsque vous créez les 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 tous les conditions d'utilisation de l'organisation en envoyant une requête 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
}

Accepter un document de conditions d'utilisation pour un développeur ou une entreprise qui utilise l'API

Acceptez 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 :

Remarque: Dans la charge utile de la réponse, auditDate est défini sur l'heure actuelle en UTC.
{
  "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

Pour afficher les conditions d'utilisation acceptées par un développeur ou une entreprise spécifique, envoyez 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 de 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
}

Modifier les conditions d'utilisation à 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} est l'identification des conditions d'utilisation. Lorsque vous effectuez la mise à jour, vous devez spécifier dans le corps de la requête les paramètres mis à jour et l'identification des conditions d'utilisation. Par exemple, la requête suivante modifie le numéro de version des conditions d'utilisation (la propriété mise à jour est mise en évidence dans l'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 les conditions d'utilisation à l'aide de l'API

Supprimez les conditions d'utilisation en envoyant une requête DELETE à /mint/organizations/{org_name}/tncs/{tncs_id}, où {tncs_id} est l'identifiant 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 de l'API

Le tableau suivant récapitule les propriétés de configuration que vous pouvez définir à l'aide de l'API pour les conditions d'utilisation.

Nom Description Par défaut Obligatoire ?
url

URL des conditions d'utilisation.

 N/A Non
tncText

Texte (par exemple, une brève description) des conditions d'utilisation.

 N/A Non
version

Version des conditions d'utilisation. Le numéro de version vous permet de suivre les différentes versions des conditions d'utilisation.

 N/A Oui
startDate

Date à laquelle les conditions d'utilisation sont en vigueur.

 N/A Oui
organization

Organisation des conditions d'utilisation

 N/A Non

Étapes suivantes

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