API管理

CATではREST APIを有効化すると、APIを経由してサービス・プロジェクト・テスト仕様書・課題・進捗などの情報を取得することができるようになります。

APIを有効化する

APIの有効化設定を行います。管理者権限を持つユーザーのみが設定可能です。

  1. システム管理画面からAPI管理を選択します。
    image

  2. API管理のREST API設定を有効化します。
    image

APIのアクセストークンを管理する

ユーザー毎にAPIのアクセストークンの設定・管理が可能です。

アカウント設定画面のページ下部にあるAPIトークンにて設定ください。

画面項目
項目 説明

新しいトークンを生成

新しいAPIトークンを生成します。

表示

マスクされたAPIトークンを表示します。

削除

APIトークンを削除します。
アカウント設定画面

画面：右上のアカウントアイコン＞アカウント設定

image

REST APIを利用してCATにアクセスをする

REST APIのリクエストを認証するには、発行されたAPIトークンをクエリパラメータ「token」の値として付加するか、もしくはリクエストヘッダー項目「X-CAT-API-KEY」の値として付加するか、どちらかの方式で実施してください。

クエリパラメータ形式

リクエストURLフォーマット
https://{your-cat-domain}.catcloud.net/api/rest/{api-request-path}?token={your-api-token}
例
https://shift-cat.catcloud.net/api/rest/services/1?token=9v4iw75o5k0j34efeu8cgzg3kj4ckdyz15azbxf3

リクエストヘッダー形式

cURLコマンドフォーマット
curl -X GET "https://{your-cat-domain}.catcloud.net/api/rest/{api-request-path}" \
-H "accept: application/json" \
-H "X-CAT-API-KEY: {your-api-token}"
例
curl -X GET "https://shift-cat.catcloud.net/api/rest/services/1" \
-H "accept: application/json" \
-H "X-CAT-API-KEY: 9v4iw75o5k0j34efeu8cgzg3kj4ckdyz15azbxf3"

利用可能なAPIをトライアル実行する

REST APIを有効化すると、APIリファレンスページ（Swagger UI）へのアクセスが可能になります。 こちらから各APIをトライアル実行して実際の挙動を確認することができます。

CAT TCM APIリファレンス（Swagger UI）

URLパス
https://{your-cat-domain}.catcloud.net/api-docs/index
例
https://shift-cat.catcloud.net/api-docs/index

cat swagger ui

APIのトライアル実行手順

  1. 一覧右上の「認証」ボタンを押下してダイアログを開き、APIキーを登録・認証する
    cat swagger auth

  2. 各APIの詳細で「トライ」ボタンを押下してリクエストフォームを開く
    cat swagger api detail

  3. パラメータを入力し、「実行」ボタンを押下する
    cat swagger api exec

  4. 実行結果を確認する
    cat swagger api response