Registro Consensi | Enesi Docs

Registrazione del consenso

POST: https://rest.ene.si/consent-register/add

Header

authorization: Bearer {access_token}

Token di accesso

Parametri

projectUid	obbligatorio	UID del progetto
consentInformationPid	obbligatorio in alternativa a consentInformationVersionId	Stringa o Array: PID della informativa di consenso
consentInformationVersionId	obbligatorio in alternativa a consentInformationPid	Stringa o Array: ID a 32 caratteri della informativa di consenso
lang	opzionale default: eng	Lingua (ita, eng, spa, deu, fra, tur, por, rus, ukr)
channel	opzionale default: web	Canale di registrazione (web, web.form, web.social.login, email, app.form)
proof	obbligatorio	Array contenente i dati necessari a provare la registrazione del consenso
userData	obbligatorio	Array contenente i dati dell'utente

Parametri userData

first_name	opzionale	Nome
last_name	opzionale	Cognome
email	opzionale	E-mail
phone	opzionale	Telefono
mobile_phone	opzionale	Cellulare
tax_code	opzionale	P.Iva o Codice Fiscale
{qualsiasi altro parametro}	opzionale	I parametri aggiuntivi possono essere compilati in due modi: `"chiave": "valore" es. "company": "Enesi"` `"chiave": {"label": "Etichetta del parametro", "value": "Valore del parametro"} es. "company": {"label": "Azienda", "value": "Enesi"}`

Risposta inserimento singolo

JSON: {
   "consentId": {consentId},
   "consentInformationVersionId": {consentInformationVersionId},
   "consentInformationPid": {consentInformationPid},
   "time": "2021-01-14 11:05:23"
}

Risposta inserimento multiplo

consentInformationPid o consentInformationVersionId passato come array

JSON: {
   "data": [
       {
           "consentId": {consentId},
           "consentInformationVersionId": {consentInformationVersionId},
           "consentInformationPid": {consentInformationPid},
           "time": "2021-01-14 11:05:23"
       }
   ]
}

cURL

curl -X POST
   -H 'Accept: application/json'
   -H 'Authorization: Bearer {access_token}'
   -d 'projectUid=10000&consentInformationPid=10001&lang=ita&channel=web.form&proof%5Burl%5D=https%3A%2F%2Fwww.enesi.it&proof%5Bhtml%5D=%3Cform%3E...%3C%2Fform%3E&userData%5Bfirst_name%5D=Mario&userData%5Blast_name%5D=Rossi&userData%5Bcodice%5D=012345&userData%5Bcompany%5D%5Blabel%5D=Azienda&userData%5Bcompany%5D%5Bvalue%5D=Enesi'
   https://rest.ene.si/consent-register/add

Parametri in formato JSON (per una migliore comprensione)

JSON: {
    "projectUid": "10000",
    "consentInformationPid": "10001",
    "lang": "ita",
    "channel": "web.form",
    "proof": {
       "url": "https:\/\/www.enesi.it",
       "html": "<form>...<\/form>"
   },
    "userData": {
        "first_name": "Mario",
        "last_name": "Rossi",
        "codice": "012345",
        "company": {
            "label": "Azienda",
            "value": "Enesi"
        }
    }
}

Ricerca dei consensi

POST: https://rest.ene.si/consent-register/search

Header

authorization: Bearer {access_token}

Token di accesso

Parametri

id	opzionale	ID del consenso
projectUid	opzionale	UID del progetto
consentInformationPid	opzionale in alternativa a consentInformationVersionId	PID della informativa di consenso
consentInformationVersionId	opzionale in alternativa a consentInformationPid	ID a 32 caratteri della informativa di consenso
lang	opzionale	Lingua (ita, eng, spa, deu, fra, tur, por, rus, ukr)
channel	opzionale	Canale di registrazione (web, web.form, web.social.login, email, app.form)
first	opzionale in alternativa a page	Booleano, se true ritorna il primo consenso
page	opzionale default: 1, in alternativa a first	Numero della pagina
perPage	opzionale default: 20, in alternativa a first	Numero di risultati per pagina (valore massimo 50)
userData	obbligatorio	Array contenente i dati dell'utente

Parametri userData

first_name	opzionale	Nome
last_name	opzionale	Cognome
email	opzionale	E-mail
phone	opzionale	Telefono
mobile_phone	opzionale	Cellulare
tax_code	opzionale	P.Iva o Codice Fiscale
{qualsiasi altro parametro}	opzionale	Valore del campo ricercato

Risposta consenso singolo (parametro first: true)

JSON: {
    "data": {
        "id": {id},
        "projectUid": "10000",
        "projectId": "752efcad07add6b41b4e154010ec44d6",
        "consentInformationPid": 10001,
        "consentInformationVersionId": "39f63f7660370fc4c06d1069d9760fe4",
        "lang": "ita",
        "time": "2021-01-14 11:08:11",
        "channel": "web.form",
        "channelData": {},
        "proof": Array,
        "userData": Array,
        "revoked": false,
        "revokeTime": null,
        "revokeChannel": null,
        "revokeChannelData": Array | null,
        "revokeProof": Array | null
    }
}

Risposta consensi multipli (parametro first: false o omesso)

JSON: {
    "page": "1",
    "totalPages": 1,
    "results": 2,
    "resultsPerPage": 20,
    "totalResults": 2,
    "data": [
       {
           "id": {id},
           "projectUid": "10000",
            "projectId": "752efcad07add6b41b4e154010ec44d6",
           "consentInformationPid": 10001,
           "consentInformationVersionId": "39f63f7660370fc4c06d1069d9760fe4",
           "lang": "ita",
           "time": "2021-01-14 11:08:11",
           "channel": "web.form",
           "channelData": {},
           "proof": Array,
           "userData": Array,
           "revoked": false,
           "revokeTime": null,
           "revokeChannel": null,
           "revokeChannelData": Array | null,
           "revokeProof": Array | null
       },
       { ... }
    ]
}

cURL

Esempio richiesta consenso singolo (parametro first: true)

curl -X POST
   -H 'Accept: application/json'
   -H 'Authorization: Bearer {access_token}'
   -d 'projectUid=10000&consentInformationPid=10001&lang=ita&channel=web.form&first=1&userData%5Bfirst_name%5D=Mario&userData%5Blast_name%5D=Rossi&userData%5Bcodice%5D=012345&userData%5Bcompany%5D=Enesi'
   https://rest.enesi8.it/consent-register/search

Parametri in formato JSON (per una migliore comprensione)

JSON: {
    "projectUid": "10000",
    "consentInformationPid": "10001",
    "lang": "ita",
    "channel": "web.form",
    "first": true,
    "userData": {
        "first_name": "Mario",
        "last_name": "Rossi",
        "codice": "012345",
        "company": "Enesi"
    }
}

Esempio richiesta consensi multipli (parametro first: false o omesso)

curl -X POST
   -H 'Accept: application/json'
   -H 'Authorization: Bearer {access_token}'
   -d 'projectUid=10000&consentInformationPid=10001&consentInformationVersionId=&lang=ita&channel=web.form&first=1&userData%5Bfirst_name%5D=Mario&userData%5Blast_name%5D=Rossi&userData%5Bcodice%5D=012345&userData%5Bcompany%5D=Enesi' 
   https://rest.enesi8.it/consent-register/search

Parametri in formato JSON (per una migliore comprensione)

JSON: {
    "projectUid": "10000",
    "consentInformationPid": "10001",
    "lang": "ita",
    "channel": "web.form",
    "page": 1,
    "userData": {
        "first_name": "Mario"
    }
}

Revoca del consenso

POST: https://rest.ene.si/consent-register/revoke

Header

authorization: Bearer {access_token}

Token di accesso

Parametri

id	obbligatorio	Id del consenso
channel	opzionale default: web	Canale di registrazione (web, web.form, web.social.login, email, app.form)
proof	obbligatorio	Array contenente i dati necessari a provare la registrazione del consenso

Risposta

JSON: {
   "revoked": true,
   "consentId": {consentId},
   "consentInformationId": {consentInformationId},
   "time": "2021-01-14 11:05:23"
}

cURL

curl -X POST
   -H 'Accept: application/json'
   -H 'Authorization: Bearer {access_token}'
   -d 'id=4d60ea7bde293bb0d218d6eeb6ba29bc&channel=web.form&proof%5Burl%5D=https%3A%2F%2Fwww.enesi.it&proof%5Bhtml%5D=%3Cform%3E...%3C%2Fform%3E'
   https://rest.ene.si/consent-register/revoke

Parametri in formato JSON (per una migliore comprensione)

JSON: {
    "id": "4d60ea7bde293bb0d218d6eeb6ba29bc",
    "channel": "web.form",
    "proof": {
       "url": "https:\/\/www.enesi.it",
       "html": "<form>...<\/form>"
   }
}

Recupero delle informative di consenso

POST: https://rest.ene.si/consent-register/information/get

Header

authorization: Bearer {access_token}

Token di accesso

Parametri

pid

obbligatorio

Stringa o array contentente i PID delle informativa di consenso richieste

Risposta

JSON: {
   "data": {
       "10001": {
           "id":"77cc55c92f68ad2c4bc98d50c280567c",
           "pid": 10001,
           "version": 6,
           "validityDays": 0, (0 equivale a infinito)
           "notification": true,
           "title": {
               "ita": "Modulo di richiesta informazioni",
               "eng": "Information request form",
               { ... }
           },
           "descriptionHtml": {
               "ita": "{ ... }",
               "eng": "{ ... }",
               { ... }
           }
       }
}

cURL

curl -X POST
   -H 'Accept: application/json'
   -H 'Authorization: Bearer {access_token}'
   -d 'pid%5B0%5D=10001&pid%5B1%5D=10002
   https://rest.ene.si/consent-register/information/get

Parametri in formato JSON (per una migliore comprensione)

JSON: {
    "pid": ["10001", "10002"]
}