【応用】APIキーを発行して外部データを更新する

APIでできること

formrunの一部機能を外部サービスで利用することができます
 
具体的には次のようなことができます
  • カード・メール情報を取得する
  • ステータスや担当者などカード情報を更新する
  • カードにメモを追加する
※ 詳細は以下ドキュメントをご確認ください

APIドキュメント

エンドポイントやレスポンスなどの仕様はこちら

利用できるプラン

  • PROFESSIONALプラン
上記プランの14日間の無料トライアルをご利用いただけます。まずはトライアルで使用感をお試しください。
※まだ無料登録がお済みでない場合は、上記リンクからトライアルを開始できます。 ※すでにアカウントをお持ちの方は、プロダクト内のプラン変更画面からトライアルを開始してください。

利用できる権限

  • チームオーナー
  • チーム管理者

API利用までの手順

APIを使うためには API key の発行が必要です

API keyの取得方法

  1. 右上の歯車マークからチーム設定を開く
 
  1. サイドバーのAPI設定をクリックし、「作成する」ボタンをクリックする
 
  1. 管理名を入力し、利用規約を確認・同意後、「作成する」をクリックする
 
  1. 発行されたAPIキーをコピーし、安全な場所に保管する
    1. APIキーは一度しか表示されないため、画面を閉じる前にコピーし、安全な場所に保管してください。第三者に共有すると、不正アクセスの原因となる可能性があります。

各IDの確認方法

エンドポイントやリクエストにidを入れる必要があるとき、以下の箇所からidをご確認ください
  • フォームID
    • フォーム上部「設定」からフォーム基本設定を開く
       
  • カードID
    • カードを開いたとき、URLの の直後にある数字
      ※ ドキュメント内では と表記されることがあります
       
  • ステータスID
    • フォーム設定「ステータス」より、各ステータスの設定を開く
 
  • ラベルID
    • フォーム設定「カードラベル」より、各ラベルの設定を開く

注意事項

  • APIキーは外部に漏洩しないよう安全な場所に保管してください
  • APIキーは1チーム2個まで作成可能です
  • メールアドレスを含めるリクエストでは、エイリアスが正常に機能しない場合があります
    • を指定したい場合、 としてください