データ削除API

Roktのデータ削除APIは、クライアントがデータ主体の削除要求を当社のプラットフォームに送信および管理できるようにします。これらのAPIは、顧客データおよびプライバシー規制に関連するプロセスを自動化し、より自信を持ってリスクを減らして実行します。

Roktは、Roktによってホワイトリストに登録された特定のアカウントに対するデータ削除要求をサポートしています。アカウントがホワイトリストに登録されておらず、データ削除へのアクセスが必要な場合は、Roktのアカウントマネージャーに連絡してください。

機能

データ削除要求は現在、Roktの内部システムによって実行される前に15日間キューに入れられています。要求のライフサイクルは次のように説明されます：

削除要求は次の通りです：

• API呼び出しを介してPENDING状態で作成されます。
• 12日後（約288時間）にREADY状態に移行します。
  • READY状態になると、必要に応じて追加の手動レビューのために内部OPSチームに通知されます。
• 3日後（約72時間）に内部システムに渡され、最大15日以内に実行されます。全体の最大プロセス期間は30日になります。
• API呼び出しを介してPENDINGまたはREADY状態でのみキャンセル可能です。ステータスはCANCELLEDに変更され、以降のGETタスク呼び出しで取得できます。

認証

Roktデータ削除APIは、こちらで説明されているレポートAPIに実装されたのと同じ認証メカニズムを共有しています。

API構造

データ削除APIの基本URLは次の通りです：https://api.rokt.com

現在利用可能なエンドポイントは次の通りです：

メソッド	エンドポイント	目的
POST	/data/deletion-requests/emails	新しいユーザーデータ削除要求を作成します。ユーザーは現在、生のメールアドレス（リスト）またはハッシュ化された（SHA256）メールアドレス（リスト）で識別されます。
GET	/data/deletion-requests	現在の（PENDING、READY）および過去の（ACTIONED、CANCELLED）データ削除要求のリストを返し、そのステータスを確認します。
DELETE	/data/deletion-requests/:task_id	READYおよびPENDING状態にあるデータ削除要求をAPIユーザーがキャンセルできるようにします。

エンドポイント

リクエストの作成

エンドポイント	/data/deletion-requests/emails
メソッド	POST
クエリパラメータ	なし

リクエスト例:

{
  "accountId": "2456192011195196284677",
  "rawEmails": [
    "test@test.com"
  ],
  "sha256Emails": [
    "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  ]
}

レスポンス例: Http Code 202

注:

• 各削除リクエストには、3つのリストのそれぞれに複数のエントリを含めることができます: rawEmails、および sha256Emails。
• リクエストが有効であるためには、3つのリストのいずれかに少なくとも1つのエントリが必要です。
• sha256Emails はbase64エンコーディングで提供する必要があります。

削除リクエストの取得

エンドポイント	/data/deletion-requests
メソッド	GET
クエリパラメータ	なし
リクエスト例	なし

レスポンス例

[
    {
        "taskId": "20675afe-f4e5-4ee6-bfb7-d5fddcffe16d",
        "status": "actioned",
        "deletionType": "emailsDeletion",
        "creationTime": "2022-03-01T11:00:00+11:00",
        "accountId": "3008848650853038987",
        "readyTime": null,
        "actionedTime": null,
        "cancelledTime": null
    }
]

削除リクエストのキャンセル

エンドポイント	/data/deletion-requests/:taskId
メソッド	DELETE
クエリパラメータ	URI内 - taskId: キャンセルされる削除リクエストのID
リクエスト例	なし

レスポンス例

{
  "data": {
    "message": "successful cancelled task with taskId: 3bc2e8b0-88ee-400c-8696-44897bc95cd3"
  }
}  

エラーハンドリング

すべてのAPIは、最も一般的なRESTfulエラーレスポンスコードに従います: 400, 403, 404, 500, など。

エラーはすべて、以下のJSON形式で呼び出し元に報告されます:

{
  "error": {
    "code": 404,
    "error": "NOT_FOUND",
    "message": "task not found for with task_id:..."
  }
}

現在サポートされているエラーコードは以下の通りです:

HTTPコード	エラー	説明
400	BAD_REQUEST	リクエストが不正または不完全です
500	INTERNAL_SERVER_ERROR	内部サーバーエラー
403	AUTHENTICATION_ERROR	リクエストの認証ができません
403	UNAUTHORIZED_ACCOUNT	使用されたアカウントは現在データ削除リクエストに対して認可されていません
404	NOT_FOUND	リソースが見つかりません
410	DEADLINE_EXCEEDED	削除リクエストはPENDINGおよびREADY状態を過ぎているためキャンセルできません