Da dove iniziare?

Per iniziare a utilizzare l'API di Consentmanager, contatta il tuo account manager per ottenere:

  • Endpoint URL
  • Chiave API
  • ID tipo di accesso

Si prega di notare che l'API REST (diversa dall'API JS) non è inclusa in tutti i pacchetti.

A cosa serve l'API REST?

I compiti tipici dell'API REST includono:

  • Automazione della gestione degli account, ad esempio:
    • Creazione e aggiornamento delle CMP
    • Aggiornamento di design e testi
    • Assegnazione dei fornitori
  • Automazione della reportistica, ad esempio:
    • Estrazione di report
    • Estrazione di protocolli

L'API REST non può essere utilizzata per:

  • Non puoi ricavare informazioni su un consenso specifico dell'utente ("Questo utente ha accettato?").
  • Non è possibile ottenere le informazioni IAB TCF
  • Non è possibile ottenere lo stato di consenso del fornitore

Per tutti i casi d'uso sopra indicati, utilizza invece l'API JS.

Specifiche OpenAPI 3 (OAS3)

L'API fornisce una specifica OAS3 una volta effettuata l'autenticazione. Ecco un esempio di flusso di lavoro che utilizza Swagger:

  1. Apri Swagger e carica https://[Endpoint-URL]/info
  2. Espandi l'azione auth > auth e clicca su Provalo
  3. Inserisci il tuo tipo di accesso e la chiave API ed esegui:

  4. Riceverai il tuo token di accesso. Copia il token e utilizzalo per richiedere una nuova specifica OAS3:

  5. La specifica OAS3 autenticata ti fornirà tutti i modelli e le azioni accessibili:
  6. Usa l'icona di autorizzazione a destra per aggiungere il tuo token di accesso:

  7. Ora puoi eseguire le azioni direttamente in Swagger