Helpshiftにおける個人データには、Helpshiftのサーバーに保存されている、エンドユーザーに関連するチケットの詳細とユーザー情報がすべて含まれます。Helpshiftは、GDPR要件に基づいてデータポータビリティのリクエストを自動的に作成するために使用できる、一連のREST APIを提供しています。データポータビリティのリクエストは、毎週処理されます。

データポータビリティのリクエストを開始するには、REST /hs-data APIを使用できます。APIコールを設定する際、ユーザーに関する情報の提供を求められます。リクエストが作成されると、Helpshiftはリクエストされたデータを収集する定期的なバッチ処理を自動的にスケジュールします。

保留中のデータポータビリティリクエストのステータスを監視するために、/hs-data/status APIを定期的に使用できます。リクエストが完了すると、圧縮形式のデータへの時間制限付きリンクが送信されます。

柔軟性を提供するため、ユーザーは以下の表で定義されているように、さまざまな方法で識別できます。

データポータビリティのリクエスト対象となるユーザーを特定したら、以下のREST APIを使用して、これらの削除リクエストを作成および監視できます。詳細については、REST APIのはじめにページをご覧ください。

パート 1: データポータビリティリクエストの作成 (POST /hs-data)

API: POST /hs-data

POST /hs-data APIは、次のようにJSON形式で「requests」オブジェクトを渡すことによって、一連のデータポータビリティリクエストを送信するために使用できます。

リクエストオブジェクトには、次のプロパティが含まれています。

 お伝えする必要のあるアプリ情報は、app_publish_idです。アプリ公開IDは、設定 > アプリ設定ページにあります（以下のスクリーンショット参照）。

サンプル CURL リクエスト:

curl -X POST
-H “Authorization: Basic ########”
-H “Cache-Control: no-cache” -H “Cache-Control: no-cache”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “requests=[ { “property”: “issue_id”%2C “value”: “270”%2C “app_publish_id”: “12”%2C “external_request_id”: “my_portdb_id_123″ } ]”
「https://api.helpshift.com/v1/ashbys/hs-data/」

応答:

以下は、POSTリクエストから返されるものです。

レスポンスボディ：

個々のレスポンスの構造は、以下の表に示されています。

パート2：ポータビリティリクエストステータスの確認

API: GET /hs-data/status

GET /hs-data/status APIは、既存のポータビリティリクエストのセットと、各リクエストの現在のステータスを返します。

フィルター:

GET /hs-data/status API は、特定のポータビリティリクエストを識別するために使用されます。少なくとも以下のいずれかのフィルターが必要です。

応答：

本文には、1つまたは複数の応答が含まれる場合がありますのでご注意ください。

レスポンスボディ：

個々のレスポンスの構造は、以下の表に示されています。

サンプル回答：

{
"ステータス": "作成済み",
“eta”: “タイムスタンプ”,
“hs_data_url”: “文字列”,
“url_valid_until”: “タイムスタンプ”,
“encrypted_zip?” : “ブール値”,
「リクエスト」: {
「プロパティ」: 「メール」
"value": "文字列",
“app_publish_id”: “文字列”,
“external_redaction_id”: “文字列”
}
}