ヘルプ連携(Google・LINE WORKS・AI)API 呼び出しの送り先を決める
API 呼び出しの送り先を決める
テナント管理者が送り先(URL と署名の鍵)を登録し、ルートの「API 呼び出し」から、ほかのシステムの API を署名付きで呼びます。
「API 呼び出し」は、申請のルートに置くステップです。ルートがそこに来ると、ほかのシステムの API に、申請の情報を送ります。たとえば、決裁が通ったら会計システムに登録する、といった使い方です。
API 呼び出しは、オプションです。使えるのは、オプションを付けた有料のプランです。Free とトライアルでは付けられません。プランとオプションの料金は、料金のページの表の「オプション」の欄を見てください。このページには、値段は書きません。API 呼び出しではチケットは使いません。
-
「API の送り先」を開く
Section titled “「API の送り先」を開く”テナント管理者が、左のメニューの「設定」を押し、「連携」の「API の送り先」を押します。登録済みの送り先が、名前・送り先のホスト・使っているテンプレートの表で並びます。
画面の画像(manual-connect-api-1)は、E2E で撮って入れます -
送り先を足す
Section titled “送り先を足す”上のバーの右の「送り先を足す」を押します。「名前」(50 文字まで)と「URL」(https:// で始まるもの)を入れて、保存します。送り先は HTTPS だけです。社内のネットワークやクラウドの内部向けのアドレスには、送れません。
画面の画像(manual-connect-api-2)は、E2E で撮って入れます -
署名の鍵を控える
Section titled “署名の鍵を控える”足すと、「「名前」の署名の鍵(この画面でだけ表示)」が出ます。「コピー」で写して、受け取る側のシステムに入れてください。閉じると、もう表示できません。なくしたときは、行を押して開く右の欄の「鍵を作り直す」で、新しい鍵を作ります。作り直すと、前の鍵はすぐに使えなくなるので、受け取る側の鍵を入れ替えてください。
画面の画像(manual-connect-api-3)は、E2E で撮って入れます -
ルートの「API 呼び出し」で、送り先と項目を選ぶ
Section titled “ルートの「API 呼び出し」で、送り先と項目を選ぶ”テンプレートを作る人が、申請のテンプレートの「ルート」のタブで、「自動の動き」から「API 呼び出し」を置きます。「送り先」を選び、「送る項目」を選びます。何も選ばなければ、項目は何も送りません。いつも送るものは、申請番号・テンプレートの名前と版・状態・このステップ・申請者の名前と所属です。申請者のメールアドレスは送りません。ファイル・繰り返し・社内メンバー・部署を選ぶ部品は、送れません。
「送り直しの回数」と、「結果を待つ」か「待たない」も決めます。はじめは「待つ(既定)」で、返事が成功(2xx)なら次へ進みます。このステップは、実行すると取り消せません。差し戻しでルートを通り直すと、もう一度呼びます。
画面の画像(manual-connect-api-4)は、E2E で撮って入れます -
受け取る側で、署名を確かめる
Section titled “受け取る側で、署名を確かめる”送るたびに、次のヘッダーが付きます。受け取る側では、同じ計算をして、署名が合うかを確かめてください。
X-Timestamp:送った時刻(UNIX 時刻の秒)X-Signature:sha256=に続けて、「タイムスタンプ.ボディ」を署名の鍵で HMAC-SHA256 にかけた値(16 進数)X-Delivery-Id:ステップを実行するごとの ID です。送り直しでも同じなので、二重に受け取ったかを見分けられます
タイムスタンプが古いリクエスト(例:5 分より前)は、受け取る側で捨ててください。同じリクエストの使い回しを防げます。送るのは
POSTで、本文は JSON です。画面の画像(manual-connect-api-5)は、E2E で撮って入れます
送り先を直す・消す
Section titled “送り先を直す・消す”行を押すと、右の欄が開きます。「直す」で名前と URL を直せます。「消す」で送り先を消せますが、消すと、ルートで選べなくなります。テンプレートや共通ルートで使っている送り先は、消せません。
うまくいかないとき
Section titled “うまくいかないとき”ルートで、送り先が選べない
「まだ送り先がありません」と出ます。テナント管理者に、「設定 → 連携 → API の送り先」で登録してもらってください。
送り先を消せない
使っているテンプレートや共通ルートがあると、消せません。その行の右の欄の「使っているテンプレート」で、どこで使っているかを見られます。
API が呼ばれなかった
返事が 2xx で返らなかったとき、10 秒以内に返事がなかったとき、送り先が HTTPS でないとき、送るときに内部向けのアドレスだったとき、リダイレクト(3xx)が返ったときは、送れなかった扱いになります。決めた回数だけ送り直し、それでもだめなら、申請は止めずに次へ進み、これまでの動きに残して、テナント管理者に知らせます。やり直す・飛ばすの操作はありません。
オプションが付いていない
ステップは、飛ばして次へ進みます。飛ばしたことは、これまでの動きに残ります。
返事の中身を、次のステップで使いたい
返事の中身は、今は使えません。分岐にも、あとのステップにも使いません。成功したか失敗したかだけを見ます。