Skip to content

はじめに

TimeTracker NX Web APIは、TimeTracker NXのデータにWeb通信を用いてアクセスするためのREST APIです。このヘルプでは、Web APIの仕様や利用方法について紹介します。

TimeTracker NX 対応バージョン

このヘルプで紹介するWeb APIは、TimeTracker NX 4.2 に対応しています。その他のバージョンでは利用できません。

Web APIの利用場面

TimeTracker NX Web APIにより、以下のような場面でさらに柔軟かつ便利な運用を実現することができます。

  • 組織の異動に伴い、ユーザー情報を一括で更新する
  • 期初に複数のプロジェクトを一括で登録する
  • TimeTracker NXの工数データを勤怠システムへ定期的に反映する

インストール

Web APIは、サーバーへのTimeTracker NXのインストール時に自動的にインストールされます。TimeTracker NXのインストール以外の準備は特に必要ありません。

前提条件

このヘルプは、以下に関する基本知識を有する人を対象としています。

  • Web API（REST）
  • TimeTracker NX

具体的には、Web APIについては、URI、HTTPといった用語について理解していることを前提とします。TimeTracker NXについては、画面上で一通りの操作を行ったことがあることを前提とします。

権限

Web APIの実行にあたっては、対象機能についてTimeTracker NXを画面上で操作する場合と同様の権限がユーザー（Web APIで認証されるユーザー）に必要です。 例えば、Web APIによりプロジェクト情報を更新するには、「プロジェクトの編集」権限が付与されている必要があります。 各APIに必要な権限については「Web API一覧」で紹介しています。