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.

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 a la vez.

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

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.de",
        "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 de 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: true / false - se ha concedido un consentimiento
• ucid: ID de consentimiento individual de un visitante
• timestamp: marca de tiempo del consentimiento
• purposes: a qué categoría pertenece el consentimiento
• embeddings: qué embeddings o cookies ha consentido el visitante
• manipulationPrevention: true / false: si se han evitado los intentos de manipulación. Es decir, no que los haya habido, sino sólo que el mecanismo de supresión estaba activo.

A continuación, puede utilizar el ucId para filtrar una entrada.

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 consentimiento. Se puede especificar completo o como una subcadena que empieza 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 aquí es que sólo hay un ID de contenido 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 consentimientos 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.