Um mit der Consentmanager-API zu beginnen, wenden Sie sich bitte an Ihren Kundenbetreuer, um Folgendes zu erhalten:

• Endpunkt-URL
• API-Schlüssel
• Zugriffstyp-ID

Bitte beachten Sie, dass die REST-API (im Gegensatz zur JS-API) nicht in allen Paketen enthalten ist.

Wozu dient die REST-API?

Zu den typischen Aufgaben der REST-API gehören:

• Automatisierung der Kontoverwaltung, z. B.:
  • Erstellung und Aktualisierung von CMPs
  • Aktualisierung von Designs und Texten
  • Zuweisung von Anbietern
  • …
• Automatisierung der Berichterstellung, z. B.:
  • Berichte abrufen
  • Protokolle abrufen

Die REST-API kann nicht verwendet werden für:

• Sie können keine Informationen über eine bestimmte Einwilligung des Nutzers abrufen („Hat dieser Nutzer zugestimmt?“).
• Sie können keine IAB-TCF-Informationen abrufen
• Sie können den Status der Zustimmung des Anbieters nicht erhalten

Verwenden Sie für alle oben genannten Anwendungsfälle bitte stattdessen die JS-API.

OpenAPI 3 (OAS3) Spezifikation

Die API stellt nach der Authentifizierung eine OAS3-Spezifikation bereit. Hier ist ein Beispiel-Workflow mit Swagger:

1. Öffne Swagger und lade https://[Endpoint-URL]/info
2. Erweitere die Aktion „auth > auth“ und klicke auf „Ausprobieren“
3. Geben Sie Ihren Zugriffstyp und Ihren API-Schlüssel ein und führen Sie den Befehl aus:
   

   

4. Sie erhalten Ihren Login-Token. Kopieren Sie den Token und verwenden Sie ihn, um eine neue OAS3-Spezifikation anzufordern:
   

   

5. Die authentifizierte OAS3-Spezifikation liefert Ihnen alle Modelle und Aktionen, auf die zugegriffen werden kann:
6. Verwenden Sie das Autorisierungssymbol auf der rechten Seite, um Ihren Login-Token hinzuzufügen:
   

   

7. Jetzt können Sie die Aktionen direkt in Swagger ausführen