splats logo

SPLATS API概要

SPLATS APIのリクエスト/レスポンスなどの詳細についてはSPLATS API仕様書を参照してください。

SPLATS API 仕様書

アクセストークン

SPLATS APIを利用するには、アクセストークンの発行が必要です。
以下の2種類の方法で発行できます。

  • 手動でアクセストークンを発行する
    SPLATSメンバーサイトからアクセストークンを手動で発行することができます。

手動発行について

  • 連携するアプリから自動でアクセストークンを発行する
    OAuth 2.0の連携方式でアクセストークンを発行することができます。
    この方法でアクセストークンを発行するにはサービス事前登録の申し込みが必要です。

自動発行について

発行したアクセストークンは、以下のようにAuthorizationリクエストヘッダーに含めてください。

Authorization: Bearer {アクセストークン}

データ形式

SPLATS APIでは、リクエストボディ、レスポンスともにJSONを利用します。

Content-Type:application/json; charset=utf-8

エンドポイント

  • https://api-link.share.splats.jp/

    • 開発環境に接続するエンドポイントです。
      弊社から開発環境を提供されている場合のみ利用できます。

  • https://api-link.splats.jp/

    • 本番環境に接続するエンドポイントです。

日時形式

SPLATS APIでは、日時を表現する場合にISO 8601 拡張形式の下記文字列を利用します。ただし、日本国内での利用のみを想定していますので、タイムゾーンは +09:00 固定で指定してください。

YYYY-MM-DDThh:mm:ss+09:00

権限時間帯の形式は下記形式で時分秒まで指定します。
詳細はSPLATS API仕様書やSPLATS API使用例を参照してください。

"start": {
  "time": "09:00:00+09:00"
},
"end": {
  "time": "18:00:00+09:00"
}

※09:00:00から18:00:00までが対象の時間帯になります。

"start": {
  "time": "00:00:00+09:00"
},
"end": {
  "time": "23:59:59+09:00"
}

※このように指定すると終日許可となります。

APIのエラーレスポンス

エラーが発生した場合、エラーコード「error_code」と、その詳細「error_detail」を含むレスポンスを返します。

エラーレスポンスフォーマット

{
  "message": <エラーメッセージ>,
  "error_code": <エラーコード>,
  "error_detail": <エラー内容詳細>
}

エラーレスポンス例

{
  "message": "Bad Request",
  "error_code": "40002",
  "error_detail": "リクエストパラメーターが不正です。"
}

リクエスト制限

SPLATS APIは発行したアクセストークンに対して、60分間に受付可能なリクエスト回数を制限します。
この制限は、リクエスト種別ごとに異なります。

リクエスト種別 60分あたりのリクエスト回数

デバイス状態取得API

180

上記を除くその他API

720

リクエスト回数が上限を超えた場合、429（Too many requests）が返され、制限リセットまでリクエストを行うことができなくなります。
レスポンスには、リクエスト制限の情報を表す以下のヘッダーが含まれます。

ヘッダー名 説明

X-Rate-Limit-Limit

期間内(60分)でリクエストできる最大回数

X-Rate-Limit-Remaining

期間内(60分)でリクエストできる残り回数

X-Rate-Limit-Reset

制限がリセットされるまでの秒数（制限がかかっている場合のみ）

※本制限については今後変更される可能性があります。

リクエストサンプル

SPLATS APIの利用シーンやリクエスト例について以下に記載しています。

SPLATS API 使用例