Title	Como implementar o Ponto de coleta com REST API

URL Name	UUID-b039d8c3-091a-a89b-ce4e-e26e68fcffa1

Content

O objetivo principal do SDK do JavaScript é fornecer um meio rápido para implementar Pontos de coleta OneTrust. O SDK usa uma arquitetura de API aberta RESTful para se comunicar com os sistemas OneTrust.

Uma alternativa à implementação do SDK é escrever seu próprio código para interagir diretamente com nossas APIs. Isso permite que você crie seus próprios fluxos de trabalho personalizados e use o serviço em aplicativos com os quais o JavaScript não é compatível.

Nota

Para obter mais informações sobre os end points e as chamadas da API do OneTrust, consulte o Portal do Desenvolvedor OneTrust.

Como usar a API Comprovantes de consentimento para criar transações

A API Comprovantes de consentimento permite que um aplicativo externo envie um pedido para armazenamento de transações de consentimento para Pontos de coleta individuais. Cada Ponto de coleta deve primeiro ser configurado no OneTrust para gerar um token de solicitação válido.

Corpo da solicitação da API Comprovantes de consentimento

A seguir estão os dados de carga útil suportados ao fazer chamadas POST em https://{BASEURL}/request/v1/consentreceipts.

{
  "identifier": "mail@mail.com",
  "identifierType": "Email",
  "generateInstantLinkToken", "true"         
  "dsDataElements":{                        
    "DataElement1Name": "Value",
    "DataElement2Name": "Value"
  },
  "language": "en-GB", 
  "interactionDate": "2019-05-14T01:34:33Z",                      
  "consentDate": "2019-05-14T01:34:33Z",
  "withdrawnDate" : "2018-03-01T09:00:00",  
  "customPayload":{                         
    "key1": "value1",
    "key2": "value2"
  },
  "requestInformation": "{JWT TOKEN}",      
  "purposes": [
  {
    "Id": "{GUID}",                        
    "TransactionType": "OPT_OUT",
    "ExpiryDate": "2020-01-01",
    "purposeNote": {  
        "noteId": "aa978afe-bbe9-4419-8fa9-f3691f1046c3",
        "noteType": "UNSUBSCRIBE_REASON", 
        "noteLanguage": "en-us",
        "noteText": "Reason 1",
                      }
    "CustomPreferences": [               
    {
      "Id": "{GUID}",
      "Options": [                      
      "{GUID}",                         
      "{GUID}"
      ]
    }
    ]
  },
  {
    "Id": "{GUID}",
    "CustomPreferences": [
    {
      "Id": "{GUID}",
      "Options": [
      "{GUID}",
      "{GUID}",
      "{GUID}"
      ]
    }
  ]
  }
  ]
}

Dados de carga útil	Descrição
identificador	Valor necessário para o identificador DS. O tipo tem base no tipo de elemento de dados do Ponto de coleta e não é validado no envio.
identifierType	Compatível somente com Pontos de coleta do tipo API que estão configurados para Configuração dinâmica. Este valor é necessário para os Pontos de coleta de configuração dinâmica. O valor (por exemplo, "E-mail") deve corresponder a um dos elementos de dados do identificador definidos na lista elementos de dados. Nota Esses dados só devem ser enviados para Pontos de coleta de configuração dinâmica.
dsDataElements (Opcional)	Opcional para capturar valores de elemento de dados do Ponto de coleta. Os elementos de dados devem ser definidos no Ponto de coleta ou serão ignorados.
idioma (Opcional)	Usado para definir o idioma do titular de dados. Compatível com formatos de código ISO. Somente idioma ou código de cultura de idioma serão aceitos.
interactionDate (Opcional)	Compatível somente com pontos de coleta do tipo API. Usado para registrar a data e a hora da interação do usuário com um Ponto de coleta. Quando usado em combinação com um transactionType declarado, vários TransactionTypes diferentes podem ser postados, e cada transação será registrada como tendo ocorrido no interactionDate. Ao usar o interactionDate, nenhuma outra data deve ser incluída na postagem. Se interactionDate e uma das outras datas forem enviadas na mesma postagem, isso gerará um erro. Os recibos podem ser publicados em ordem desatualizada utilizando a Data de Interação na API de recibos de consentimento, que pode ser particularmente útil ao enviar dados históricos de consentimento. Isso significa que os novos recibos de entrada, com uma Data de Interação anterior à última data registrada em relação a cada perfil de titular de dados específico, criarão uma transação, mas não atualizarão o Status da finalidade. Por exemplo, se você publicar um comprovante RETIRADO com uma data de interação de 3 de maio, seguido de um comprovante NÃO FORNECIDO para o mesma finalidade com uma data de interação anterior de 2 de maio, o perfil do titular de dados mostrará um Status de finalidade RETIRADO com base na data de interação mais recente. Nota Recomenda-se que a interactionDate seja usada em vez de consentDate e withdrawnDate.
customPayload (Opcional)	Armazena quaisquer dados personalizados em pares de valores-chave em relação ao comprovante. O tamanho total dos dados customPayload não deve exceder 4.000 caracteres.
requestInformation	Token gerado pelo Ponto de coleta. Deve ser usado sem alteração.
Finalidades	A lista de finalidades para as quais o consentimento está sendo dado ou alterado.
ID da finalidade	Valor necessário. Inclua somente os GUIDs para finalidades que estão sendo consentidos, a menos que esteja usando o Tipo de transação. Definirá o status de consentimento como ATIVO ou PENDENTE, dependendo da configuração de Reconfirmação de participação do Ponto de coleta.
TransactionType (Opcional)	Compatível somente com pontos de coleta do tipo API. Valores suportados: PENDENTE, CONFIRMADO, RETIRADO, VENCIDO, NÃO_FORNECIDO, ESTENDER, NÃO_PARTICIPAÇÃO, EXCLUSÃO_FORÇADA, SEM_ESCOLHA, MUDAR_PREFERÊNCIAS, CANCELAR. Os valores aceitáveis também podem ser determinados por outras configurações no Ponto de coleta. Por exemplo, PENDENTE só será aceito se o Ponto de coleta estiver definido como reconfirmação de participação. SEM_ESCOLHA está atualmente disponível apenas para Pontos de coleta do tipo Conformidade com cookies.
ExpiryDate (Opcional)	Data de validade explícita opcional. Se um valor for inserido, ele substituirá o comprimento do consentimento na finalidade. A data deve ser definida no futuro em relação à data e hora atuais. Depois que a data de expiração for atingida, uma tarefa programada será executada para atualizar o status de consentimento para Expirado. Nota Pode haver um atraso de até 12 horas após a data de validade ter sido atingida para que o status Expirado seja refletido no perfil do titular de dados.
purposeNote	Dados opcionais que podem incluir NoteID, noteType, noteLanguage e noteText.
noteId (Opcional)	UUID de um modelo de motivo. Essa ID deve ser válida ou será ignorada. Use essa ID somente se quiser vincular a nota a um modelo de motivo.
noteType (Opcional)	Tipo do modelo de motivo. Se usado, o valor deve ser MOTIVO_DE_CANCELAMENTO.
noteLanguage (Opcional)	Código ISO para o idioma do texto da nota.
noteText (Opcional)	Texto da nota a ser armazenado com um máximo de 500 caracteres. Se você incluir purposeNote em sua carga útil, esse valor deve estar presente.
CustomPreferences (Opcional)	Valor opcional com base em Preferências personalizadas associadas à finalidade.
Opções	As preferências personalizadas podem ser de seleção única ou múltipla, opcional ou obrigatória, mas isso não é validado pela API. A definição de mais de um valor em seleção única será aceita, mas poderá resultar em problemas quando o DS iniciar sessão em uma Central de preferências que inclua estes dados. Inclua apenas as GUIDs para as opções a serem escolhidas.
[en] generateInstantLinkToken [en] (Optional)	[en] Flag to generate an instant access magic link token for the Preference Center that expires after one year, with a default value of false. Nota [en] This flag requires an API type collection point.

Resposta

A seguinte resposta será retornada pela API:

{"instantLinkToken": "{JWT TOKEN}","receipt": "{JWT TOKEN}"
}

Resposta	Descrição
consentReceipt	Um JWT que contém o registro da transação.
[en] instantLinkToken	[en] This token can be appended to the Preference Center login URL for a data subject login.

Como modificar preferências usando a API Comprovantes de consentimento

Você pode passar a API Comprovantes de consentimento com o tipo de transação MUDAR_PREFERÊNCIAS para modificar as seleções existentes de opção de tópico e preferência personalizada para os titulares de dados existentes. O uso desse tipo de transação permite que você opte explicitamente por um titular de dados dentro ou fora de opções de preferência individuais sem ter que incluir todas as opções existentes na carga útil.

O que você precisa saber

Ao passar o tipo de transação MUDAR_PREFERÊNCIAS, é importante lembrar das seguintes observações:

O tipo de transação MUDAR_PREFERÊNCIAS só está disponível para Pontos de coleta do tipo API.
Há diferenças significativas na carga útil de preferência personalizada ao passar por esse tipo de transação, portanto, tenha cuidado ao implementar.
Você pode declarar CONFIRMAÇÃO_DE_PARTICIPAÇÃO como um parâmetro TransactionType ou deixá-lo em branco para optar por um titular de dados em uma opção Tópico ou Preferência personalizada.
Não inclua os IDs dos itens que não estão sendo modificados.
Se não houver registro de consentimento existente para o titular de dados (ou seja, o tipo de transação MUDAR_PREFERÊNCIAS é a primeira transação para o titular dos dados para esses finalidades), o registro de consentimento será criado com um status ATIVO e as preferências serão aplicadas.
[en] The CHANGE_PREFERENCES transactionType should only be used to modify preferences for an existing data subject with a purpose in Active status, or to create a new data subject record.

Exemplo de carga útil

{
2  "identifier": "changepref@otprivacy.com",
3  "requestInformation": "{JWT}",
4  "purposes": [
5    {
6      "Id": "6ede4731-b0d3-44f9-8eca-0b82d211e084",
7      "TransactionType":"CHANGE_PREFERENCES",
8      "CustomPreferences": [
9        {
10          "Id": "a3f54f53-0747-4d98-b428-0b2316162122",
11          "Choices": [
12              {
13            "OptionId":"614bafbc-60e0-46c7-9f0f-411fcd83cbc3",
14            "TransactionType":"OPT_OUT"
15              },
16              {
17            "OptionId":"4c8bdec4-552d-4a72-9029-a218124b8c19",
18            "TransactionType":"OPT_OUT"
19              }
20            
21          ]
22        }
23        
24      ]
25    }
26  ]
27}

Como ignorar o fluxo de trabalho de reconfirmação de participação

Você pode ignorar o fluxo de trabalho da reconfirmação de participação para uma interação individual do titular de dados, passando o seguinte parâmetro na API Comprovantes de consentimento:

“doubleOptIn”: false

Quando uma chamada POST é feita com o parâmetro adicional, um tipo de transação CONFIRMADA em vez de PENDENTE será gerado. O titular de dados receberá um status ATIVO para todas as finalidades no Ponto de coleta.

Nota

O e-mail de confirmação de dupla aceitação ou eventos de fluxo de trabalho personalizados em que o identificador não é um endereço de e-mail não serão acionados.

Attachment

Article Total View Count 18,527

Language	Portuguese (Brazil)

Is Primary Language

Como implementar o Ponto de coleta com REST API

Nota

Como usar a API Comprovantes de consentimento para criar transações

Corpo da solicitação da API Comprovantes de consentimento

Nota

Nota

Nota

Nota

Resposta

Como modificar preferências usando a API Comprovantes de consentimento

O que você precisa saber

Exemplo de carga útil

Como ignorar o fluxo de trabalho de reconfirmação de participação

Nota