Para empezar a utilizar la API de ConsentManager, ponte en contacto con tu gestor de cuentas para obtener:
- URL de destino
- Clave API
- ID de tipo de acceso
Ten en cuenta que la API REST (a diferencia de la API JS) no está incluida en todos los paquetes.
¿Para qué sirve la API REST?
Las tareas típicas de la API REST incluyen:
- Automatización de la gestión de cuentas, p. ej.:
- Creación y actualización de CMP
- Actualización de diseños y textos
- Asignación de proveedores
- …
- Automatización de la generación de informes, p. ej.:
- Extracción de informes
- Extracción de protocolos
La API REST no se puede utilizar para:
- No puedes extraer información sobre el consentimiento específico de un usuario («¿Aceptó este usuario?»).
- No puedes obtener información del IAB TCF
- No puedes obtener el estado de consentimiento del proveedor
Para todos los casos de uso anteriores, utiliza la API de JS en su lugar.
Especificación OpenAPI 3 (OAS3)
La API proporciona una especificación OAS3 una vez que te has autenticado. Aquí tienes un ejemplo de flujo de trabajo utilizando Swagger:
- Abre Swagger y carga https://[Endpoint-URL]/info
- Despliega la acción «auth > auth» y haz clic en «Pruébalas».
- Introduce tu tipo de acceso y tu clave API y ejecútalo:
- Recibirás tu token de inicio de sesión. Copia el token y utilízalo para solicitar una nueva especificación OAS3:
- La especificación OAS3 autenticada te proporcionará todos los modelos y acciones a los que se puede acceder:
- Utiliza el icono de autorización de la derecha para añadir tu token de inicio de sesión:
- Ahora puedes ejecutar las acciones directamente en Swagger