REST APIを使用して収集ポイントを実装する

同意受領書APIを使用すると、外部アプリケーションで、個別の収集ポイントの同意トランザクションを保管するためのリクエストを提出できます。有効なリクエストトークンを生成するために、OneTrustで各収集ポイントを最初にセットアップする必要があります。

同意受領書APIリクエスト本文

以下に、https://{BASEURL}/request/v1/consentreceiptsでPOSTコールを実行する場合にサポートされるペイロードデータを示します。

{
  "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}"
      ]
    }
  ]
  }
  ]
}

回答

APIによって次の回答が返されます。

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

CHANGE_PREFERENCES（優先設定を変更する）トランザクションタイプを使用して同意受領書APIを渡すことで、既存のデータ主体の既存のトピックおよびカスタム優先設定のオプションの選択を変更できます。このトランザクションタイプを使用すると、ペイロード内に既存のすべての選択肢を含めなくとも、個々の優先設定の選択でデータ主体を明示的にオプトインまたはオプトアウトすることができます。

知っておくべきこと

CHANGE_PREFERENCES（基本設定を変更する）トランザクションタイプを渡すときには、次のことに注意する必要があります。

サンプルペイロード

{
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}

同意受領書APIで次のパラメータを渡すことによって個別のデータ主体のインタラクションのダブルオプトインワークフローをバイパスすることができます。

“doubleOptIn”: false

追加のパラメータを使用してPOSTコールを実行するときには、PENDINGではなくCONFIRMEDのトランザクションタイプが生成されます。その後、収集ポイント上のすべての目的に対してデータ主体にACTIVE（アクティブ）ステータスが付与されます。