Par où commencer ?

Pour commencer à utiliser l'API Consentmanager, veuillez contacter votre chargé de compte afin d'obtenir :

  • URL de destination
  • Clé API
  • ID de type d'accès

Veuillez noter que l'API REST (autre que l'API JS) n'est pas incluse dans tous les forfaits.

À quoi sert l'API REST ?

Les tâches typiques de l'API REST comprennent :

  • Automatisation de la gestion des comptes, par exemple :
    • Création et mise à jour des CMP
    • Mise à jour des designs et des textes
    • Attribution des prestataires
  • Automatisation de la création de rapports, par exemple :
    • Extraction de rapports
    • Extraction de protocoles

L'API REST ne peut pas être utilisée pour :

  • Vous ne pouvez pas extraire d'informations concernant le consentement d'un utilisateur spécifique (« Cet utilisateur a-t-il accepté ? »).
  • Vous ne pouvez pas obtenir les informations IAB TCF
  • Vous ne pouvez pas obtenir le statut de consentement du fournisseur

Pour tous les cas d'utilisation ci-dessus, veuillez utiliser l'API JS à la place.

Spécification OpenAPI 3 (OAS3)

L'API fournit une spécification OAS3 une fois que vous êtes authentifié. Voici un exemple de workflow utilisant Swagger :

  1. Ouvrez Swagger et chargez https://[Endpoint-URL]/info
  2. Développez l'action « auth > auth » et cliquez sur « Essayer ».
  3. Saisissez votre type d'accès et votre clé API, puis exécutez la commande :

  4. Vous recevez votre jeton de connexion. Copiez le jeton et utilisez-le pour demander une nouvelle spécification OAS3 :

  5. La spécification OAS3 authentifiée vous fournira tous les modèles et actions accessibles :
  6. Utilisez l'icône d'autorisation à droite pour ajouter votre jeton de connexion :

  7. Vous pouvez désormais exécuter les actions directement dans Swagger

We do our best to keep this purely informative documentation up to date. However, if you notice that any of these guides need a little touch-up, let us know!