その他
公開API情報確認
カテゴリー

公開APIとは

公開APIとは

ここでは、カオナビが公開しているAPIを紹介します。

APIを利用することで、他システムとカオナビをつないでデータのやり取りを行うことができます。

公開APIのバージョン

最新バージョンは2.0です。
カオナビではバージョン1(以下v1)、バージョン2(以下v2)の2つの公開APIを利用可能です。

v1とv2の違い

v2は、v1からいくつかの改善を行っています。

  • リクエスト回数の上限を増加(1社あたり毎時60回まで → 毎時1000回まで)
  • 必須・文字数チェックなどのエラー判定をタスク実行前に行うように変更
  • シートの定義情報をAPIから取得できるように変更
  • シートの部分更新APIを送信した値のみかつ複数メンバーを更新できる仕様に変更
  • REST APIの形式になり、インターフェースをわかりやすく変更
  • 計算式パーツはAPI実行時に再計算される仕様に変更

v1からv2への移行計画

2022年度内を目処に、v1のサポートを終了予定です。
※時期が決まりましたら改めてサポートサイトにてお知らせいたします。

公開API画面を開く

カオナビトップ画面からグローバルヘッダーの『SET UP』をクリックします。

『管理者機能トップ』が表示されるので、『公開API情報確認』(v1)または『公開API v2 情報』(v2)をクリックします。

画面の見方

v1

認証情報
連携設定に使用する認証情報が表示されます。

シート情報表示エリア
シート名をクリックすると、シート定義情報が表示されます。
画像は基本情報を選択したときの画面です。

v2

実行結果
公開APIの実行結果が表示されます。

アクセスログ
実行結果の詳細なログが表示されます。
※『データ安心パック』ご契約中のお客様環境のみ表示されます

認証情報
連携設定に使用する認証情報が表示されます。

APIドキュメントへのリンク
APIドキュメント(v2)が表示されます。

v2の画面に関する詳細はこちらをご覧ください。