承認ワークフロー

できること

FlipLinkの承認ワークフローでは、ビューアーがドキュメントの承認をリクエストできます。2つのエンドポイントで設定します。

• ビューアーに承認リクエストボタンを追加する。有効にすると、承認リクエストのワークフローが起動します。
• 承認ワークフローで使うメールテンプレートを設定する — リクエスト、リマインダー、提出のメール。

承認ワークフローは、Documentアイテムのみ（DocType=documentで作成したアイテム）に適用されます。標準のフリップブックでは利用できません。

始める前に

必要なものは次のとおりです。

• APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• {flipbookId} — 設定するドキュメントの数値IDです。create-by-file／create-by-url（IDとして）や一覧から返されます。
• すべてのリクエストの送信先はベースURL https://go.fliplink.meです。

どちらのエンドポイントも、form-urlencodedのボディ（JSONではありません）を取ります。

承認ボタンを追加する

PUT /api/set-approval-button/{flipbookId}は、ビューアーに承認リクエストボタンを追加します。有効にすると、承認リクエストのワークフローが起動します。

curl -X PUT 'https://go.fliplink.me/api/set-approval-button/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsApprovalButton=true' \
  --data-urlencode 'ApprovalButtonText=Request approval' \
  --data-urlencode 'ApprovalButtonColor=#0055FF' \
  --data-urlencode 'ApprovalButtonTextColor=#FFFFFF'

フィールド:

• IsApprovalButton — trueで承認リクエストボタンを表示、falseで非表示にします。
• ApprovalButtonText — ボタンのラベル。
• ApprovalButtonColor — ボタンの背景色。先頭に#を付けた16進値（例: #0055FF）です。デフォルトは#000000。値はそのまま保存され、APIでは検証しません。
• ApprovalButtonTextColor — ボタンの文字色。先頭に#を付けた16進値（例: #FFFFFF）です。デフォルトは#FFFFFF。値はそのまま保存され、APIでは検証しません。

レスポンス:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

承認メールテンプレートを設定する

PUT /api/set-approval-email-templates/{flipbookId}は、承認ワークフローで使うメールテンプレートを設定します。各フィールドには組み込みのデフォルトテキストがあり、フィールドを空のままにすると、そのデフォルトが保たれます。

テンプレートのテキストには、##TOKEN##形式のマージトークンを含められます。これはメールの送信時に置き換えられます。たとえば、##DOCUMENT_TITLE##はドキュメントのタイトルを挿入します。

curl -X PUT 'https://go.fliplink.me/api/set-approval-email-templates/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'EmailApproveRequestSubject=Approval needed: ##DOCUMENT_TITLE##' \
  --data-urlencode 'EmailApproveRequestBody=' \
  --data-urlencode 'EmailApproveRemindSubject=' \
  --data-urlencode 'EmailApproveRemindBody=' \
  --data-urlencode 'EmailApproveSubmitSubject=' \
  --data-urlencode 'EmailApproveSubmitBody='

レスポンス:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

起こりうるエラー

• APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Keyヘッダーが存在し、正しいことを確認してください。
• アイテムIDが見つからないか、キーが所有していない場合 → HTTP 200でMessage: "Item not found"。
• 不明またはスペルミスのボディフィールド → HTTP 200でMessage: "Unknown field(s) '…'. Expected: …"。

メモ

• メールテンプレートのエンドポイントでは、各フィールドに組み込みのデフォルトテキストがあります。フィールドに空の値を送ると、そのテンプレートのデフォルトが保たれます。
• メールテンプレートのテキストは、##TOKEN##のマージトークン（例: ドキュメントのタイトルを表す##DOCUMENT_TITLE##）に対応しており、送信時に置き換えられます。
• ボタンの色（ApprovalButtonColor、ApprovalButtonTextColor）は、先頭に#を付けた16進値で、検証なしにそのまま保存されます。デフォルトは#000000と#FFFFFFです。