このドキュメントはBizteX cobitのAPIドキュメントです。現在このAPIはベータ版としてリリースしています。

ベースURLは https://api.cobit.biztex.co.jp/v1 です。成功時の結果は特に明記のない場合 JSON (application/json) で返ります。

APIを実行するにはAPIトークンを以下のように Authorization ヘッダに指定してください:

Authorization: Bearer API_TOKEN

APIトークンはcobitに管理者でログインして、「環境設定」にある「APIトークン」から生成できます。生成方法の詳細は こちら を参照してください。

APIの呼び出し可能回数はひとつの組織につき5分あたり300回までです。制限回数をこえると 429 Too Many Requests 応答を返します。 残りの呼び出し可能な回数やリセットされる時間はレスポンスヘッダから参照できます。

時間あたりのAPIの呼び出し回数や制限の単位は今後変更される可能性があります。

また、呼び出し回数が制限値を大きくこえるような場合はDoS攻撃と判断され、この仕様の範囲外でアクセスが制限される可能性があります。

通常時のレスポンスヘッダの例

利用回数が制限内に収まっている場合は以下のレスポンスヘッダが返ります:

HTTP/1.1 200 OK
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 173
X-RateLimit-Reset: 1535539500

それぞれのヘッダは以下を表しています:

• X-RateLimit-Limit: 単位時間あたりの最大呼び出し可能回数。
• X-RateLimit-Remaining: 残りの呼び出し可能回数。
• X-RateLimit-Reset: 呼び出し可能回数がリセットされる時間（Unix time）。

制限をこえた場合のレスポンスヘッダの例

利用回数が制限回数をこえると以下のレスポンスヘッダが返ります:

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 0
X-RateLimit