エンドポイント共通仕様

共通仕様

プロトコル

HTTPSで通信します。HTTPでは接続できません。

文字コード

リクエスト・レスポンスの文字コードはUTF-8です。

レート制限

APIごとに実行できるリクエスト回数の制限は以下のとおりです。

APIリクエスト回数の制限
ユーザごとに10,000/時

ステータスコード

JINS MEME APIからは以下のステータスコードが返されます。

ステータスコード説明
200
ok
リクエストが成功しました。
400
bad_request
不正なリクエストパラメータを受信しました。送信パラメータが仕様通りであるか確認してください。
401
invalid_client
OAuth認証に失敗しました。アプリID・アプリSecretを確認してください。
403
forbidden
リソースを利用する権限がありません。アプリID・アプリSecretを確認してください。
404
not_found
対象のリソースが見つかりませんでした。
409
conflict
更新データの競合によりデータの更新に失敗しました。再実行してください。
429
too_many_requests
リクエスト回数の上限を超過しました。時間を空けて再実行してください。
500
internal_server_error
内部サーバのエラーです。
503
server_unavailable
サーバが一時的に高負荷です。時間を空けて再実行してください。

レスポンスヘッダー

JINS MEME APIのレスポンスには以下のHTTPヘッダーが含まれます。

レスポンスヘッダー説明
X-RateLimit-Limit最大リクエスト回数
X-RateLimit-Remaining残リクエスト回数
X-RateLimit-Resetリクエスト回数制限のリセット時間(エポック秒形式)

エラーレスポンス

エラー発生時は、以下のJSONデータを含むレスポンスボディが返されます。

プロパティ説明
errorエラー名称
error_descriptionエラー詳細メッセージ

以下はエラー発生時のJSONレスポンスの例です。

{
  "error":"internal_server_error",
  "error_description":"Error Message."
}

アクセス範囲

各APIのスコープによるアクセス可否は以下のとおりです。

APIrunofficedrive
アクセストークン取得
ログアウト
RUN NEXT APPイベント取得--
OFFICE APPイベント取得--
OFFICE 計測データ取得--
OFFICE サマリデータ取得--
DRIVE 計測データ取得--
DRIVE サマリデータ取得--
デバイス種別取得
OFFICIALアプリ情報取得
パーソナル情報取得
デバイス識別情報取得