メインコンテンツまでスキップ

概要

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

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

機能​

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

Data deletion API cycle

削除リクエストは次のように処理されます:

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

認証​

Roktデータ削除APIは、認証手順で説明されているイベントおよびレポートAPIに実装されているのと同じ認証メカニズムを共有しています。

APIにアクセスするには、AppIdと関連するAppSecretが必要です。これらは上記のドキュメントで説明されているようにRoktダッシュボードで生成できます。あるいは、アカウントマネージャーに連絡してプロセスを案内してもらうこともできます。

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_idREADYおよびPENDING状態にあるデータ削除リクエストをキャンセルすることをAPIユーザーに許可します。

エンドポイント​

リクエストの作成​
エンドポイント/data/deletion-requests/emails
メソッドPOST
クエリパラメータなし
リクエストの例:​
{
  "accountId": "2456192011195196284677",
  "rawEmails": [
    "test@test.com"
  ],
  "sha256Emails": [
    "kJbnntuJYvQBhPiiHQcz6OSn0EyvzVeOBmtsG2sWkyU="
  ]
}
レスポンスの例: Http Code 202​

注釈:

  • 各削除リクエストには、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コードエラー説明
400BAD_REQUESTリクエストが不正または不完全です
500INTERNAL_SERVER_ERROR内部サーバーエラー
403AUTHENTICATION_ERRORリクエストの認証に失敗しました
403UNAUTHORIZED_ACCOUNT使用されたアカウントは現在データ削除リクエストの認可を受けていません
404NOT_FOUNDリソースが見つかりません
410DEADLINE_EXCEEDED削除リクエストはPENDINGおよびREADY状態を過ぎているためキャンセルできません
この記事は役に立ちましたか？