メインコンテンツまでスキップ

Web APIの利用方法

TimeTracker NX Web API では、プロジェクトやワークアイテムといったリソースに対して URI が割り当てられており、その URI に対して GET、POST、PUT、DELETE といった HTTP の標準的なメソッドを使用してリクエストを送ることで対象のリソースを操作します。

APIの実行形式​

TimeTracker NX Web APIを利用するには、「メソッド」+「URI」で指定する必要があります。 メソッドには、取得(GET)、追加(POST)、更新(PUT)、削除(DELETE) を指定できます。URIの基本形式は以下のとおりです。

http(s)://サーバー名/Webサイト名/api/エリア/リソース

「サーバー名」は TimeTracker NX のサーバー名、「Webサイト名」はTimeTracker NX のWebサイト名です。 「エリア」はAPIの分類を表しており、「リソース」は実際の操作対象となるデータ（オブジェクト）を示します。

備考

「エリア」と「リソース」の詳細は、次のリンクを参照ください。： 「Web API一覧」

備考

「http(s)://サーバー名/Webサイト名/api/」の部分は、全てのAPIで共通であるため、ヘルプ内では省略して記載します。

認証方式​

Web API のリクエストには認証情報を含める必要があります。TimeTracker NX Web APIでは以下の認証方式に対応しています。

  • Basic 認証
  • トークンベースの認証
Warning

Basic 認証は、ユーザー/パスワード 情報が解析できてしまうリスクがあるため、認証方式はトークンベースを推奨します。

Basic認証​

Basic 認証では、HTTP の Authorization ヘッダに、「Basic」に続いて「ログイン名:パスワード」を BASE64 エンコードした値を指定します。

Authorization: Basic b2thbW90bzpwYXNzd29yZA==

トークンベースの認証​

トークンベースの認証では、HTTP の Authorization ヘッダに、「Bearer」に続いてトークンを指定します。

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
備考

トークン認証に用いるトークンは、APIで生成することができます。
詳しくは次のリンクを参照ください。： 「APIリファレンス(auth)」

注意

取得したトークンを14日間使用しない場合、対象のトークンは無効になります。
なお、使用していたとしても生成してから30日で対象のトークンは無効になります。
その場合は、再度生成してください。

APIキーの認証​

ユーザー単位でAPIキーを作成し、ヘッダ情報に指定してください。

  1. APIキーの作成：以下のページを参照ください。
    「APIキーを生成する」
  2. APIキーの適用
    HTTPリクエストヘッダに以下を指定してください。（［APIキー］を1の情報で差し替えてください） 
    X-TT-ApiKey：［APIキー］

レスポンス​

レスポンスボディ​

レスポンスはすべて JSON 形式で返されます。API の種類によりレスポンスには以下の情報が含まれます。

エラーコード​

エラーが発生した場合は、エラーに関する情報を以下のような JSON で返します。
エラーコードの一覧は、次のリンクを参照ください。： 「共通仕様(エラーコード)」

[{
   "code": "IdNotFound",
   "resource" : "WorkItem",
   "field": "id",
   "id" : "345253",
   "message": "指定したワークアイテムは存在しないか削除されています。"
}]
に最終更新