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

概要

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

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

機能​

データ削除リクエストは現在、Roktの内部システムによってアクションが行われる前に15日間キューに保管されます。リクエストのライフサイクルは以下のように説明されます：

データ削除APIのサイクル

削除リクエストは次のようになります：

  • PENDING状態でAPIコールを介して作成されます。
  • 12日後（約288時間）にREADY状態に移動します。
    • READY状態になると、必要に応じて追加の手動レビューのために内部OPSチームに通知されます。
  • 3日後（約72時間）に内部システムに渡され、最大15日間内でアクションが行われます - 全体の最大プロセス期間は30日となります。
  • PENDINGまたはREADY状態のときのみAPIコールを介してキャンセル可能です。ステータスは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_idAPIユーザーがREADYおよびPENDINGの状態にあるデータ削除リクエストをキャンセルできるようにします。

エンドポイント​

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