Zum Inhalt

API de dominio / API general

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

Clave API

Encontrará la clave API propiamente dicha en la pantalla siguiente. Utilice el botón "Crear nueva clave API" para restablecer la clave y, a continuación, aparecerá directamente en la pantalla.

Tenga en cuenta que las consultas existentes pueden dejar de funcionar durante este paso, ya que la clave antigua 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 esto, la llamada no tiene éxito. Cada clave sólo es válida para una cuenta.

La llamada se realiza generalmente a través de una simple llamada GET en el navegador, curl o cualquier otra forma de llamar a los datos web.

API de prueba

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.

{
    "nombre_usuario": "tu_nombre_usuario",
    "apiKey": "IHR_API_KEY"
}

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/dominios

La respuesta debería ser la siguiente

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

El domId es la información más importante - puedes usarlo para recuperar más información sobre el dominio.

Obtener todos los consentimientos del registro

Utilice el siguiente punto final de la API-para recuperar todos los consentimientos del bloque de datos actual del registro. No se tienen en cuenta las entradas del registro que ya se han archivado. Sustituya {domainId} en la url por un ID de dominio-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 sesión Papoo CMS"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208338,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de sesión Papoo CMS"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true
        "ucid": "cba4803da92a9b39ffa82cc93aecbe00bc3f695530ebd3f7e67326404073bdbd",
        "timestamp": 1608131136,
        "propósitos": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de sesión Papoo CMS"
        },
        "manipulationPrevention": true
    }
]

Los consentimientos son los siguientes

  • consent: boolean - Se ha configurado Consent-
  • ucid: identificador individual del visitante en Consent-
  • timestamp: marca de tiempo del consentimiento
  • purposes: a qué categoría pertenece el consentimiento
  • embeddings": qué incrustaciones o cookies ha aceptado el visitante
  • manipulationPrevention: boolean: si se han evitado los intentos de manipulación. Es decir, no es que los haya habido, sino que el mecanismo de supresión-estaba activo.

Puede utilizar el ucid para filtrar las entradas por visitante.

Encontrar una entrada y leer los datos

Este punto final de la API-se puede utilizar para filtrar las entradas del registro por ID de Consent-. Éste puede introducirse completo o como una subcadena empezando por el principio del ID de Consent-. En el siguiente ejemplo, las entradas también se pueden encontrar con el valor 387f1 para el parámetro {consentId}.

Lo único importante aquí es que sólo hay un ID de Consent-que empieza por 387f1. En caso de colisión, la solicitud devuelve una lista vacía.

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

Esta llamada muestra 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 sesión Papoo CMS"
        },
        "manipulationPrevention": true
    },
    {
        "consent": true
        "ucid": "387f1d311b2e7ba1f67722ac08bfdaf56aad3ecab6f11309d0c829f4e255af12",
        "timestamp": 1608208338,
        "purposes": {
            "41ba25c": "Técnicamente necesario"
        },
        "embeddings": {
            "16bd7f0": "Gestión de sesión Papoo CMS"
        },
        "manipulationPrevention": true
    }
]

Como puede ver, el ucid es idéntico en cada caso y los consentimientos tienen marcas de tiempo diferentes.


Estadísticas-Recuperar datos

Con el siguiente punto final de la API-puede recuperar todos los datos estadísticos-de los últimos 30 días de un dominio. Sustituya {domainId} en la url 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 del script
  • Banner views → banner-Fade-ins
  • acceptAll → Número de clics en "Aceptar todo"
  • decline → Número de clics en "Rechazar todo"
  • leave → Salto