Zum Inhalt

API de dominios / API general

Con la API específica para dominios, puede integrar datos de consentimiento y de eventos por dominio en otros sistemas a través de una interfaz SSL segura.

Clave API

Encontrará la clave API en el panel que aparece a continuación. Al hacer clic en el botón «Crear nueva clave API», se generará una nueva clave, que aparecerá inmediatamente en el panel.

Tenga en cuenta que, tras este paso, es posible que las consultas existentes dejen de funcionar, ya que la clave anterior ya no es válida.

screenshot-2020.12.17-13_59_55-1608209995197.jpg

La llamada se realiza generalmente con su clave API como parámetro GET-apiKey; sin ella, la llamada no se completará con éxito. Cada clave solo es válida para una cuenta.

La llamada se realiza, por lo general, mediante una simple solicitud GET en el navegador, con curl o mediante cualquier otro método para acceder a datos web.

Probar la API

Puede realizar una llamada de prueba. Para ello, utilice el siguiente punto final de la API-:

GET /api/test

El sistema debería responder de la siguiente manera:

{
    "username": "Su_nombre_de_usuario",
    "apiKey": "SU_CLAVE_API"
}

Listar todos los dominios de la cuenta

Para listar todos los dominios de su cuenta, utilice el siguiente punto final de la API-.

GET /api/domains

La respuesta debería ser la siguiente:

[
    {
        "id": "b61cd4a",
        "name": "https:\/\/www.test-xy.de",
        "whiteLabel": false,
        "viewCount": 0
    },
    {
        "id": "1ed845d",
        "name": "test-12.de",
        "whiteLabel": false,
        "viewCount": 0
    }
]

El domId es la información más importante: le permite obtener más datos sobre el dominio.

Obtener todos los consentimientos del registro

Con el siguiente punto final de la API-puede obtener todos los consentimientos del bloque de datos actual del registro. No se tienen en cuenta las entradas del registro ya archivadas. Sustituya en la URL {domainId} por un ID de dominio-obtenido de la consulta anterior.

GET /api/domains/{domainId}/consents

La respuesta es la siguiente:

[
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208345,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de la sesión de Papoo CMS"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208338,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de la sesión de Papoo CMS"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true,
        "ucid": "cba4803da92a9b39ffa82cc93aecbe00bc3f695530ebd3f7e67326404073bdbd",
        "timestamp": 1608131136,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de la sesión de Papoo CMS"
        },
        "manipulationPrevention": true
    }
]

Los consentimientos se enumeran de la siguiente manera:

  • consent: booleano – ¿se han realizado ajustes en los consentimient-?
  • ucid: el identificador individual de consentimiento-de un visitante
  • timestamp: marca de tiempo del consentimiento
  • purposes: a qué categoría pertenece el consentimiento
  • embeddings: a qué integraciones o cookies ha dado su consentimiento el visitante
  • manipulationPrevention: booleano: indica si se han bloqueado intentos de manipulación. Esto no significa que haya habido tales intentos, sino únicamente que el mecanismo de prevención-estaba activo.

Mediante el ucid puede filtrar las entradas por visitante.

Buscar una entrada y leer los datos

Con este punto final de la API-se pueden filtrar las entradas del registro por el ID de consentimiento-. Este debe indicarse completo o bien como una subcadena que comience por el principio del ID de consentimiento-. En el siguiente ejemplo, las entradas también se pueden encontrar con el valor 387f1 para el parámetro {consentId}.

Lo único importante es que solo haya un ID de Consent-que comience por 387f1. En caso de colisiones, la solicitud devuelve una lista vacía.

GET /api/domains/{domainId}/consents/{consentId}

Esta llamada muestra entonces todo el historial de consent-de esta clave; un ejemplo

[
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208345,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de la sesión de Papoo CMS"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true,
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208338,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de la sesión de Papoo CMS"
        },
        "manipulationPrevention": true
    }
]

Como puede ver, el ucid es siempre el mismo, mientras que los consentimientos tienen marcas de tiempo diferentes.


Obtener datos estadísticos de-

Con el siguiente punto final de la API-puede consultar todos los datos estadísticos de-de los últimos 30 días de un dominio. Sustituya en la URL {domainId} por un ID de dominio-de la consulta anterior.

GET /api/domains/{domainId}/statistics

Se muestran los siguientes datos por día:

  • x → Fecha
  • Calls → Llamadas al script
  • Banner views → Visualizaciones de banners-- acceptAll → Número de clics en «Aceptar todo»- decline → Número de clics en «Rechazar todo»- leave → Abandono