Webhookとは、送信したファイルが閲覧された、印刷された、ファイルがダウンロードされたといったことが起こったときに、APIアップデートを受け取ることができるように購読することができる通知です。
Digifyはイベントの詳細をJSONとしてあなたのWebhook URLにPOSTします。始めるには、"Digify Webhookを作成 "し、以下のものを提供する必要があります：
ウェブフックの適切な説明
DigifyがWebhookをPOSTするためのURL
基本認証のためのユーザー名とパスワード
Digify Webhookは次のようなイベントで送信されます：
ファイルが閲覧されたとき
ファイルが印刷されたとき
ファイルがダウンロードされたとき
Webhook イベントは以下の属性を含んでいます：
1. AccessType - 属性の値は、設定されているファイル権限によって決まります。
誰でも - ファイル リンクを持つ誰でもファイルにアクセスできます。RecipientUserEmail、RecipientFirstName、RecipientLastName 属性は空になります。
誰でも電子メール - ファイル・リンクを持ち、電子メール・アドレスを提供した人は誰でもファイルにアクセスできます。RecipientUserEmail属性は、受信者が提供したEメールアドレスを返します。
認証されたユーザー - メールアドレスを認証されたか、アカウントを作成した Digify ユーザーは、ファイルにアクセスすることができます。RecipientUserEmail 属性、RecipientFirstName 属性、RecipientLastName 属性は、そのユーザーの詳細を返します。
(注意: ユーザーがメールアドレスを認証しているが、Digify アカウントを作成していない場合、RecipientFirstName 属性は受信者のメールアドレスを返し、RecipientLastName 属性は空になります)
2. EventTime - イベントがトリガーされた時間。
3. FileGUID - 送信されたファイルに割り当てられたID。
4. FileName - 送信されたファイルの名前。
5. Link - 送信ファイルのリンク。
6. RecipientFirstName - 受信者の名。
7. RecipientLastName - 受信者の姓。
8. RecipientUserEmail - 受信者のメールアドレス。
9. Type - ウェブフック・イベントのタイプ。View（表示）、Print（印刷）、Download（ダウンロード）のいずれかを指定します。
サンプルWebhook
表示イベント
閲覧イベントは、以下のシナリオでトリガーされます：
パーミッションが「Restrict」に設定されている場合、各受信者が初めてファイルを開いたときにWebhookが送信されます。
パーミッションが "Public "に設定され、RequestEmailが "false "に設定されている場合、最初の受信者がファイルを開いたときにWebhookが送信されます。
パーミッションが "Public "に設定され、RequestEmailが "true "に設定されている場合、ファイルが開かれるたびにWebhookが送信されます。
Content-Type: application/json
Accept-Encoding: gzip
Cf-Ray: 371d1ddc6be1192c-HKG
Cf-Visitor: {"scheme":"https"}
Authorization: Basic dGVzaDpEZW1vMTIzNA==
Connection: close
Total-Route-Time: 0
Host: requestb.in
Via: 1.1 vegur
Connect-Time: 0
Content-Length: 255
X-Request-Id: c7ab2411-da1b-4a4e-aa40-ebb227d3a443
{
"RecipientUserEmail": "tester1@email.com",
"RecipientFirstName": "Digify",
"RecipientLastName": "Tester1",
"FileGUID": "1f51447850d247d791a5d9c295af79c5",
"FileName": "secret.pdf",
"Type": "View",
"EventTime": "2017-06-20T07:46:50.6762428Z"
"AccessType": "Verified User"
}
印刷イベント
受信者がファイルを印刷すると、印刷イベントがトリガーされます。
Content-Type: application/json
Accept-Encoding: gzip
Cf-Ray: 371d1ddc6be1192c-HKG
Cf-Visitor: {"scheme":"https"}
Authorization: Basic dGVzaDpEZW1vMTIzNA==
Connection: close
Total-Route-Time: 0
Host: requestb.in
Via: 1.1 vegur
Connect-Time: 0
Content-Length: 255
X-Request-Id: c7ab2411-da1b-4a4e-aa40-ebb227d3a443
{
"RecipientUserEmail": "tester1@email.com",
"RecipientFirstName": "Digify",
"RecipientLastName": "Tester1",
"FileGUID": "1f51447850d247d791a5d9c295af79c5",
"FileName": "secret.pdf",
"Type": "Print",
"EventTime": "2017-06-20T07:46:50.6762428Z"
"AccessType": "Verified User"
}
ダウンロードイベント
受信者があなたのファイルをダウンロードすると、ダウンロードイベントが発生します。
Content-Type: application/json
Accept-Encoding: gzip
Cf-Ray: 371d1ddc6be1192c-HKG
Cf-Visitor: {"scheme":"https"}
Authorization: Basic dGVzaDpEZW1vMTIzNA==
Connection: close
Total-Route-Time: 0
Host: requestb.in
Via: 1.1 vegur
Connect-Time: 0
Content-Length: 255
X-Request-Id: c7ab2411-da1b-4a4e-aa40-ebb227d3a443
{
"RecipientUserEmail": "tester1@email.com",
"RecipientFirstName": "Digify",
"RecipientLastName": "Tester1",
"FileGUID": "1f51447850d247d791a5d9c295af79c5",
"FileName": "secret.pdf",
"Type": "Download",
"EventTime": "2017-06-20T07:46:50.6762428Z"
"AccessType": "Verified User"
}
翻訳は人工知能によって生成されており、不正確なものが含まれている可能性があります。