Con TIM Open puoi partecipare alla community degli sviluppatori, pubblicare le tue soluzioni su TIM Digital Store, utilizzare e rivendere i servizi di TIM.

Guarda anche

Panoramica

Introduzione

La Easy Privacy API consente ad uno sviluppatore di creare delle Privacy Policy e richiederne successivamente ai suoi utenti il relativo consenso.

Sicurezza

Autenticazione

L’API EasyPrivacy descritta in questo documento adotterà il meccanismo di autenticazione che si basa su un API-Key. L’API-Key sarà fornita nel parametro KeyId dell’header http della richiesta.

Policies

Policy

La risorsa Policy esposta tramite questa API.

Crea
POST/privacy/v3/policy

Crea una Policy.

Example URI

POST /privacy/v3/policy
Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Body
{
  "normativaPrivacy": "In questa sezione sono raccolti i principali riferimenti normativi che dovranno essere accettati",
  "nomePolicy": "Lorem Ipsum",
  "redirectUrl": "http://my.site.it/endpoint",
  "nomeRichiedente": "Lorem Ipsum"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "normativaPrivacy": {
      "type": "string",
      "description": "Testo della normativa."
    },
    "nomePolicy": {
      "type": "string",
      "description": "Nome della Policy"
    },
    "redirectUrl": {
      "type": "string",
      "description": "Lo sviluppatore verrà notificato ad ogni cambio stato dei consensi tramite una chiamata REST in POST verso l’url fornito."
    },
    "nomeRichiedente": {
      "type": "string",
      "description": "Nome richiedente."
    }
  },
  "required": [
    "normativaPrivacy",
    "nomePolicy",
    "nomeRichiedente"
  ]
}
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": {
    "id": "Hello, world!",
    "normativaPrivacy": "Hello, world!",
    "stato": "Hello, world!",
    "sviluppatore": {
      "timOpenId": "Hello, world!",
      "nome": "Hello, world!"
    },
    "dataCreazione": "Hello, world!",
    "nomePolicy": "Hello, world!",
    "redirectUrl": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificativo della privacy Policy"
        },
        "normativaPrivacy": {
          "type": "string",
          "description": "Testo della normativa della Policy"
        },
        "stato": {
          "type": "string",
          "description": "Stato della policy"
        },
        "sviluppatore": {
          "type": "object",
          "properties": {
            "timOpenId": {
              "type": "string",
              "description": "TimOpenId dello sviluppatore"
            },
            "nome": {
              "type": "string",
              "description": "Nome del richiedente"
            }
          },
          "required": [
            "timOpenId",
            "nome"
          ]
        },
        "dataCreazione": {
          "type": "string",
          "description": "Data della creazione della Policy"
        },
        "nomePolicy": {
          "type": "string",
          "description": "Nome della policy"
        },
        "redirectUrl": {
          "type": "string",
          "description": "URI a cui viene inviata la notifica dell'operazione"
        }
      },
      "required": [
        "id",
        "normativaPrivacy",
        "stato",
        "sviluppatore",
        "dataCreazione",
        "nomePolicy",
        "redirectUrl"
      ]
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Policy

La risorsa Policy esposta tramite questa API.

Attiva/Disattiva
PUT/privacy/v3/policy/{idPrivacyPolicy}{?active}

Attiva o disattiva una Policy.

Example URI

PUT /privacy/v3/policy/5981f1812d040e1a386a3c40?active=true
URI Parameters
HideShow
idPrivacyPolicy
string (required) Example: 5981f1812d040e1a386a3c40

Identificativo della Policy da attivare o disattivare.

active
boolean (required) Example: true

Valori possibili (Attiva: true,Disattiva: false)

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": {
    "id": "Hello, world!",
    "normativaPrivacy": "Hello, world!",
    "stato": "Hello, world!",
    "sviluppatore": {
      "timOpenId": "Hello, world!",
      "nome": "Hello, world!"
    },
    "dataCreazione": "Hello, world!",
    "nomePolicy": "Hello, world!",
    "redirectUrl": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificativo della privacy Policy"
        },
        "normativaPrivacy": {
          "type": "string",
          "description": "Testo della normativa della Policy"
        },
        "stato": {
          "type": "string",
          "description": "Stato della policy"
        },
        "sviluppatore": {
          "type": "object",
          "properties": {
            "timOpenId": {
              "type": "string",
              "description": "TimOpenId dello sviluppatore"
            },
            "nome": {
              "type": "string",
              "description": "Nome del richiedente"
            }
          },
          "required": [
            "timOpenId",
            "nome"
          ]
        },
        "dataCreazione": {
          "type": "string",
          "description": "Data della creazione della Policy"
        },
        "nomePolicy": {
          "type": "string",
          "description": "Nome della policy"
        },
        "redirectUrl": {
          "type": "string",
          "description": "URI a cui viene inviata la notifica dell'operazione"
        }
      },
      "required": [
        "id",
        "normativaPrivacy",
        "stato",
        "sviluppatore",
        "dataCreazione",
        "nomePolicy",
        "redirectUrl"
      ]
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Policy

La risorsa Policy esposta tramite questa API.

Elenco
GET/privacy/v3/policy{?nomePolicy,stato}

Recupera la lista delle policies create.

Example URI

GET /privacy/v3/policy?nomePolicy=nome_policy&stato=true
URI Parameters
HideShow
nomePolicy
string (optional) Example: nome_policy

Identificativo della Policy da ricercare.

stato
boolean (optional) Example: true

Stato delle policies

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": {
    "policies": [
      {
        "id": "Hello, world!",
        "normativaPrivacy": "Hello, world!",
        "stato": "Hello, world!",
        "sviluppatore": {
          "timOpenId": "Hello, world!",
          "nome": "Hello, world!"
        },
        "dataCreazione": "Hello, world!",
        "nomePolicy": "Hello, world!",
        "redirectUrl": "Hello, world!"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "object",
      "properties": {
        "policies": {
          "type": "array"
        }
      },
      "required": [
        "policies"
      ]
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Operazioni

La risorsa Operazioni esposta tramite questa API.

Recupera Storico
GET/privacy/v3/policy/{idPrivacyPolicy}/operazioni

Recupera lo storico delle operazioni effettuate su una Policy.

Example URI

GET /privacy/v3/policy/5981f1812d040e1a386a3c40/operazioni
URI Parameters
HideShow
idPrivacyPolicy
string (required) Example: 5981f1812d040e1a386a3c40

Identificativo della Policy.

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": {
    "id": "Hello, world!",
    "normativaPrivacy": "Hello, world!",
    "stato": "Hello, world!",
    "sviluppatore": {
      "timOpenId": "Hello, world!",
      "nome": "Hello, world!"
    },
    "dataCreazione": "Hello, world!",
    "nomePolicy": "Hello, world!",
    "redirectUrl": "Hello, world!",
    "operazioni": [
      {
        "tipo": "Hello, world!",
        "data": "Hello, world!"
      }
    ]
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificativo della privacy Policy"
        },
        "normativaPrivacy": {
          "type": "string",
          "description": "Testo della normativa della Policy"
        },
        "stato": {
          "type": "string",
          "description": "Stato della policy"
        },
        "sviluppatore": {
          "type": "object",
          "properties": {
            "timOpenId": {
              "type": "string",
              "description": "TimOpenId dello sviluppatore"
            },
            "nome": {
              "type": "string",
              "description": "Nome del richiedente"
            }
          },
          "required": [
            "timOpenId",
            "nome"
          ]
        },
        "dataCreazione": {
          "type": "string",
          "description": "Data della creazione della Policy"
        },
        "nomePolicy": {
          "type": "string",
          "description": "Nome della policy"
        },
        "redirectUrl": {
          "type": "string",
          "description": "URI a cui viene inviata la notifica dell'operazione"
        },
        "operazioni": {
          "type": "array"
        }
      },
      "required": [
        "id",
        "normativaPrivacy",
        "stato",
        "sviluppatore",
        "dataCreazione",
        "nomePolicy",
        "redirectUrl",
        "operazioni"
      ]
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Consensi

Consenso

La risorsa Consenso esposta tramite questa API.

Richiedi
POST/privacy/v3/consenso{?sms}

Richiedi il Consenso per una specifica Policy

Example URI

POST /privacy/v3/consenso?sms=false
URI Parameters
HideShow
sms
boolean (optional) Example: false

Indica se l’utente dovrà ricevere la notifica di richiesta consenso tramite un sms true o no false

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Body
{
  "idPrivacyPolicy": "5981f1812d040e1a386a3c40",
  "phoneNumber": "3323923923"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "idPrivacyPolicy": {
      "type": "string",
      "description": "Identificativo della Policy."
    },
    "phoneNumber": {
      "type": "string",
      "description": "Numero di telefono."
    }
  },
  "required": [
    "idPrivacyPolicy",
    "phoneNumber"
  ]
}
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": {
    "id": "Hello, world!",
    "applicazione": "Hello, world!",
    "nomePolicy": "Hello, world!",
    "stato": "Hello, world!",
    "normativaPrivacy": "Hello, world!",
    "sviluppatore": {
      "timOpenId": "Hello, world!",
      "nome": "Hello, world!"
    },
    "dataConsenso": "Hello, world!",
    "phoneNumber": "Hello, world!",
    "idPrivacyPolicy": "Hello, world!",
    "operazioni": [
      {
        "tipo": "Hello, world!",
        "data": "Hello, world!"
      }
    ],
    "link": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificativo del consenso"
        },
        "applicazione": {
          "type": "string",
          "description": "Nome dell'applicazione"
        },
        "nomePolicy": {
          "type": "string",
          "description": "Nome della policy"
        },
        "stato": {
          "type": "string",
          "description": "Stato del consenso"
        },
        "normativaPrivacy": {
          "type": "string",
          "description": "Testo della normativa della Policy"
        },
        "sviluppatore": {
          "type": "object",
          "properties": {
            "timOpenId": {
              "type": "string",
              "description": "TimOpenId dello sviluppatore"
            },
            "nome": {
              "type": "string",
              "description": "Nome del richiedente"
            }
          },
          "required": [
            "timOpenId",
            "nome"
          ]
        },
        "dataConsenso": {
          "type": "string"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Numero di telefono per cui è stato richiesto il consenso"
        },
        "idPrivacyPolicy": {
          "type": "string",
          "description": "Id della privacy Policy per cui è stato richiesto il consenso"
        },
        "operazioni": {
          "type": "array"
        },
        "link": {
          "type": "string",
          "description": "Link di accesso per l'utente alla gestione consensi"
        }
      },
      "required": [
        "id",
        "applicazione",
        "nomePolicy",
        "stato",
        "normativaPrivacy",
        "sviluppatore",
        "dataConsenso",
        "phoneNumber",
        "idPrivacyPolicy",
        "operazioni",
        "link"
      ]
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Stato

La risorsa Stato esposta tramite questa API.

Recupera Stato
GET/privacy/v3/consenso/verifica{?idPrivacyPolicy,phoneNumber}

Recupera lo stato del Consenso per una specifica Policy

Example URI

GET /privacy/v3/consenso/verifica?idPrivacyPolicy=5981f1812d040e1a386a3c40&phoneNumber=3323923923
URI Parameters
HideShow
idPrivacyPolicy
string (required) Example: 5981f1812d040e1a386a3c40

Identificativo della Policy.

phoneNumber
string (required) Example: 3323923923

Numero di telefono.

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": {
    "id": "Hello, world!",
    "nome": "Hello, world!",
    "descrizione": "Hello, world!"
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "nome": {
          "type": "string",
          "description": "Stato del Consenso"
        },
        "descrizione": {
          "type": "string",
          "description": "Descrizione"
        }
      },
      "required": [
        "id",
        "nome",
        "descrizione"
      ]
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Consenso

La risorsa Consenso esposta tramite questa API.

Recupera Elenco
GET/privacy/v3/consenso/{?idPrivacyPolicy,phoneNumber,stato}

Ottieni la lista dei consensi relativi ad una Policy.

Example URI

GET /privacy/v3/consenso/?idPrivacyPolicy=5981f1812d040e1a386a3c40&phoneNumber=3323923923&stato=true
URI Parameters
HideShow
idPrivacyPolicy
string (optional) Example: 5981f1812d040e1a386a3c40

Identificativo della Policy.

phoneNumber
string (optional) Example: 3323923923

Numero di telefono.

stato
boolean (optional) Example: true

Stato del consenso.

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "description": "Hello, world!",
  "data": [
    {
      "id": "Hello, world!",
      "applicazione": "Hello, world!",
      "nomePolicy": "Hello, world!",
      "stato": "Hello, world!",
      "normativaPrivacy": "Hello, world!",
      "sviluppatore": {
        "timOpenId": "Hello, world!",
        "nome": "Hello, world!"
      },
      "dataConsenso": "Hello, world!",
      "phoneNumber": "Hello, world!",
      "idPrivacyPolicy": "Hello, world!",
      "operazioni": [
        {
          "tipo": "Hello, world!",
          "data": "Hello, world!"
        }
      ],
      "link": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    },
    "data": {
      "type": "array"
    }
  },
  "required": [
    "status",
    "description",
    "data"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Consenso

La risorsa Consenso esposta tramite questa API.

Stato
PUT/privacy/v3/consenso/{idConsenso}

Nega Consenso

Example URI

PUT /privacy/v3/consenso/5981f1812d040e1a386a3c40
URI Parameters
HideShow
idConsenso
string (required) Example: 5981f1812d040e1a386a3c40

Identificativo del Consenso da negare.

Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "data": {
    "id": "Hello, world!",
    "phoneNumber": "Hello, world!",
    "nomePolicy": "Hello, world!",
    "vecchioStato": "Hello, world!",
    "nuovoStato": "Hello, world!",
    "redirectUrl": "Hello, world!"
  },
  "status": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identificativo del consenso"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Numero di telefono per cui è stato richiesto il consenso"
        },
        "nomePolicy": {
          "type": "string",
          "description": "Nome della policy"
        },
        "vecchioStato": {
          "type": "string",
          "description": "Stato precedente del consenso"
        },
        "nuovoStato": {
          "type": "string",
          "description": "Stato attuale del consenso"
        },
        "redirectUrl": {
          "type": "string",
          "description": "URI a cui viene inviata la notifica dell'operazione"
        }
      },
      "required": [
        "id",
        "phoneNumber",
        "nomePolicy",
        "vecchioStato",
        "nuovoStato",
        "redirectUrl"
      ]
    },
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    }
  },
  "required": [
    "data",
    "status",
    "description"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Loghi

ShortName

ShortName

La risorsa ShortCompanyName esposta tramite questa API permette di personalizzare il link all’applicazione consensi, di default viene valorizzato con il nome dell’azienda.

Scegli ShortName
POST/privacy/v3/shortname

Crea l’identificativo della company da usare per la personalizzazione di EasyPrivacy - Lo ShortCompanyName può contenere solo lettere alfabetiche.

Example URI

POST /privacy/v3/shortname
Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Body
{
  "shortName": "apple"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "shortName": {
      "type": "string",
      "description": "ShortCompanyName associato all'azienda."
    }
  },
  "required": [
    "shortName"
  ]
}
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "data": {
    "shortName": "Hello, world!"
  },
  "status": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "shortName": {
          "type": "string",
          "description": "ShortCompanyName dell'azienda"
        }
      },
      "required": [
        "shortName"
      ]
    },
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    }
  },
  "required": [
    "data",
    "status",
    "description"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Aggiorna ShortName
PUT/privacy/v3/shortname

Aggiorna l’identificativo della company da usare per la personalizzazione di EasyPrivacy - Lo ShortCompanyName può contenere solo lettere alfabetiche.

Example URI

PUT /privacy/v3/shortname
Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Body
{
  "shortName": "apple"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "shortName": {
      "type": "string",
      "description": "ShortCompanyName associato all'azienda."
    }
  },
  "required": [
    "shortName"
  ]
}
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "data": {
    "shortName": "Hello, world!"
  },
  "status": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "shortName": {
          "type": "string",
          "description": "ShortCompanyName dell'azienda"
        }
      },
      "required": [
        "shortName"
      ]
    },
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    }
  },
  "required": [
    "data",
    "status",
    "description"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json

Leggi ShortName
GET/privacy/v3/shortname

Leggi l’identificativo della company da usare per la personalizzazione di EasyPrivacy

Example URI

GET /privacy/v3/shortname
Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow

Operazione eseguita con successo

Headers
Content-Type: application/json
Body
{
  "data": {
    "shortName": "Hello, world!"
  },
  "status": "Hello, world!",
  "description": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "shortName": {
          "type": "string",
          "description": "ShortCompanyName dell'azienda"
        }
      },
      "required": [
        "shortName"
      ]
    },
    "status": {
      "type": "string",
      "description": "Esito dell'operazione"
    },
    "description": {
      "type": "string",
      "description": "Descrizione dell'operazione"
    }
  },
  "required": [
    "data",
    "status",
    "description"
  ]
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi: Sottoscrizione non attiva, Frequenza traffico richieste superata, Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json