【応用】APIキーを発行して外部データを更新する
APIでできること
formrunの一部機能を外部サービスで利用することができます。
具体的には次のようなことができます。
- カード・メール情報を取得する
- ステータスや担当者などカード情報を更新する
- カードにメモを追加する
上記の自動化は開発者の手を借りずに構築できます。最適な連携方法を知りたい方はぜひご相談ください。
APIドキュメント・API仕様書
開発者向けのエンドポイントやレスポンスなどの仕様はこちら
利用できるプラン
- PROFESSIONALプラン
上記プランの14日間の無料トライアルをご利用いただけます。まずはトライアルで使用感をお試しください。
※まだ無料登録がお済みでない場合は、上記リンクからトライアルを開始できます。
※すでにアカウントをお持ちの方は、プロダクト内のプラン変更画面からトライアルを開始してください。
利用できる権限
- チームオーナー
- チーム管理者
API利用までの手順
APIを使うためには API key の発行が必要です
API keyの取得方法
- 右上の歯車マークからチーム設定を開く
- サイドバーのAPI設定をクリックし、「作成する」ボタンをクリックする
- 管理名を入力し、利用規約を確認・同意後、「作成する」をクリックする
- 発行されたAPIキーをコピーし、安全な場所に保管する
- APIキーは一度しか表示されないため、画面を閉じる前にコピーし、安全な場所に保管してください。第三者に共有すると、不正アクセスの原因となる可能性があります。
各IDの確認方法
エンドポイントやリクエストにidを入れる必要があるとき、以下の箇所からidをご確認ください
- フォームID
フォーム上部「設定」からフォーム基本設定を開く
- カードID
カードを開いたとき、URLの の直後にある数字
※ ドキュメント内では と表記されることがあります
- ステータスID
フォーム設定「ステータス」より、各ステータスの設定を開く
- ラベルID
フォーム設定「カードラベル」より、各ラベルの設定を開く
注意事項
- APIキーについて
- 1チーム2個まで作成可能です。
- 外部に漏洩しないよう安全な場所に保管してください。
- 他のツールとの連携や自動化（ワークフロー）にて、エイリアスメールアドレス（「+」を利用したアドレス）を利用する場合
- 他のツールとの連携や自動化（ワークフロー）を組む場合、エイリアスメールアドレス（「+」を利用したアドレス）が含まれていると正常に機能しないことがあります。
- メールアドレスに含まれる「」を「」にワークフローツール「workrun」等にて変換して設定してください。
- 例）変更前： 変更後：
＜「workrun」をご利用の場合の設定画面画像＞
- カードの添付ファイル情報の取得について
- 添付ファイルはURL形式で取得でき、リンクの有効期限は1時間です。
- 添付ファイルのURLは、有効期限内であれば、ログイン不要で誰でもアクセスできる状態となるため、情報の取り扱いには十分注意してください。