Aby rozpocząć korzystanie z API Consentmanager, skontaktuj się ze swoim opiekunem klienta, aby uzyskać:

• Adres URL punktu docelowego
• Klucz API
• Identyfikator typu dostępu

Należy pamiętać, że REST API (inny niż JS API) nie jest zawarty we wszystkich pakietach.

Do czego służy REST API?

Typowe zadania dla REST API obejmują:

• Automatyzacja zarządzania kontami, np.:
  • Tworzenie i aktualizacja CMP
  • Aktualizacja projektów i tekstów
  • Przydzielanie dostawców
  • …
• Automatyzacja raportowania, np.:
  • Pobieranie raportów
  • Pobieranie protokołów

Interfejsu API REST nie można używać do:

• Nie możesz pobierać informacji o konkretnej zgodzie użytkownika („Czy ten użytkownik wyraził zgodę?”).
• Nie można uzyskać informacji IAB TCF
• Nie można uzyskać statusu zgody dostawcy

We wszystkich powyższych przypadkach użycia proszę zamiast tego korzystać z interfejsu API JS.

Specyfikacja OpenAPI 3 (OAS3)

API udostępnia specyfikację OAS3 po uwierzytelnieniu. Oto przykładowy przebieg pracy z wykorzystaniem Swaggera:

1. Otwórz Swagger i załaduj https://[Endpoint-URL]/info
2. Rozwiń opcję „auth > auth” i kliknij „Wypróbuj”
3. Wprowadź swój typ dostępu i klucz API, a następnie uruchom:
   

   

4. Otrzymasz token logowania. Skopiuj token i użyj go, aby poprosić o nową specyfikację OAS3:
   

   

5. Uwierzytelniona specyfikacja OAS3 zawiera wszystkie dostępne modele i akcje:
6. Użyj ikony autoryzacji po prawej stronie, aby dodać swój token logowania:
   

   

7. Teraz możesz uruchamiać akcje bezpośrednio w Swaggerze