その他
公開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 利用時の注意点

データバックアップと日次バッチのタイミング

深夜1:00~1:30の間にデータバックアップを行い、データバックアップの終了後、早朝にかけて日次バッチを実施しています。

データバックアップの静止点を考慮いただき、API更新のタイミングをご検討ください。

データバックアップは、処理を開始した時点でのデータが静止点となり、当日のデータバックアップとして保持されます。
そのため、当日のデータとしてAPI更新されたい場合は1:00より前に実施し、翌日のデータとして更新されたい場合は1:30以降をご検討ください。
※データバックアップの復元は、データ安心パックをご利用のお客様が対象です。

また日次バッチ中にAPI更新を行った場合、開始時間の早い方から処理がされます。
先行された処理の間、もう一方の処理は待機状態となり、完了してから次の処理が実行されます。
日次バッチの開始時間及び終了時間はお客様ごとに異なります。
具体的な時間についてはサポートデスクまでお問い合わせください。

データバックアップと日次バッチの違い

  • データバックアップ
    弊社にて内部的に取得している前日時点でのデータ全体のバックアップ処理。
    データ安心パックをご利用の場合、このデータバックアップから復元されます。
  •  

  • 日次バッチ
    基本情報、シート情報のCSVファイルのバックアップファイル生成、
    基本情報、シート内の日付計算によるデータ更新処理、
    予約されたデータの更新 などが実施されます。
    実際の処理時間は、CSV入出力画面の『バックアップ』のタイムスタンプから確認できます。
  • 公開API画面を開く

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

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

    画面の見方

    v1

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

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

    v2

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

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

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

    操作対象の管理
    メンバー情報・シート情報ごとに「取得」「更新」の可否を設定・確認できます。

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

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