SPLATS Developers Site

拡張版SPLATS APIを利用する

利用条件

拡張機能のご利用には、有償ライセンスのお申し込みが必要です。ご利用形態に応じたライセンスをお申し込みください。
拡張機能を利用する際には、ライセンスキーが必要です。ライセンスキーは、有償ライセンスのお申し込み後に当社より発行いたします。
拡張機能をご利用になる各テナントごとに、ライセンスキーの有効化（以下「アクティベート」と記載）が必要です。

アクティベートとは、発行されたライセンスキーで拡張機能の利用をテナントごとに有効にするプロセスです。
SPLATS APIが提供するアクティベートAPIを利用することで、各テナントごとに拡張機能の有効化や無効化を制御できます。
アクティベートされたテナントのみ、拡張機能をご利用いただけます。
なお、ご契約中のライセンスで利用できるテナント数の上限に達している場合、新たなテナントをアクティベートすることはできません。
追加で必要なライセンスをお申し込みのうえ、アクティベートしてください。
また、アクティベート済みのテナントの確認や、アクティベートの無効化もアクティベートAPIで行うことが可能です。

アクティベートの手順

対象ライセンスキーでテナントごとに拡張機能の利用を有効化する手順について説明します。
アクティベートするには、対象テナントのテナントIDが必要です。
事前にテナント情報を取得できるアクセストークンをご用意のうえ、テナント情報取得API を利用してテナントIDを取得してください。

アクティベート実行のリクエスト例
項目	内容
エンドポイント	https://api-link.splats.jp/activations
HTTPメソッド	POST
リクエストヘッダー	`Content-Type: application/json`
リクエストボディ	`{ "license_key": {LICENSE_KEY}, "tenant_id": {TENANT_ID} }`

リクエストボディ (* 必須)
パラメーター	タイプ	説明
license_key*	string	当社から発行されたライセンスキー
tenant_id*	string	アクティベートするテナントのID

成功レスポンス例

{
  "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "tenant_name": "株式会社○○",
  "activated_at": "2025-08-29T13:00:00+09:00"
}

成功レスポンス
パラメーター	タイプ	説明
tenant_id	string	アクティベートしたテナントのID
tenant_name	string	アクティベートしたテナント名
activated_at	string	アクティベートが実行された日時

HTTP STATUS CODE: 200

アクティベートの確認

対象ライセンスキーでアクティベート済みのテナント情報一覧を取得する方法について説明します。

アクティベート確認のリクエスト例
項目	内容
エンドポイント	https://api-link.splats.jp/activations?license_key={LICENSE_KEY}
HTTPメソッド	GET

クエリパラメーター (* 必須)
パラメーター	タイプ	説明
license_key*	string	当社より発行されたライセンスキー

成功レスポンス例

{
  "activations": [
    {
      "tenant_id": "xxxxxx-xxxxxx-xxxxx",
      "tenant_name": "テナント名",
      "activated_at": "2025-07-07T10:30:00Z"
    },
    {
      "tenant_id": "xxxxxx-xxxxxx-xxxxx",
      "tenant_name": "テナント名",
      "activated_at": "2025-07-06T15:45:00Z"
    }
  ],
  "activated_count": 2,
  "activation_limit": 10
}

成功レスポンス
パラメーター	タイプ	説明
activations	array of objects	アクティベート済みのテナント情報の配列各要素は `tenant_id` (テナントID)、`tenant_name` (テナント名)、`activated_at` (アクティベート日時)で構成されます。
activated_count	number	アクティベート済みのテナント数
activation_limit	number	指定したライセンスキーで利用可能なテナントの上限数

HTTP STATUS CODE: 200

アクティベートの無効化

対象ライセンスキーでアクティベート済みのテナントを無効化する手順について説明します。
アクティベートを無効化するには、対象テナントのテナントIDが必要です。
アクティベートの確認、またはテナント情報を取得できるアクセストークンをご用意のうえ、テナント情報取得API を利用してテナントIDを取得してください。

アクティベート無効化のリクエスト例
項目	内容
エンドポイント	https://api-link.splats.jp/activations/revoke
HTTPメソッド	POST
リクエストヘッダー	`Content-Type: application/json`
リクエストボディ	`{ "license_key": {LICENSE_KEY}, "tenant_id": {TENANT_ID} }`

リクエストボディ (* 必須)
パラメーター	タイプ	説明
license_key*	string	当社より発行されたライセンスキー
tenant_id*	string	アクティベートを無効化するテナントのID

リクエストが成功した場合、HTTP STATUS CODE: 200 とともに空のオブジェクトがレスポンスされます。

エラーレスポンス

アクティベートAPI実行時に、入力内容や状態によってはエラーが返されることがあります。
代表的なエラーコードとその説明、対応方法は以下の通りです。

エラーレスポンス
エラーコード	説明	対応方法
40070	無効なライセンスキーを指定した。	ライセンスキーが無効化されている可能性があります。詳細についてはお問い合わせください。
40071	アクティベート済みのテナントIDを指定した。	すでにアクティベートされているため、再度アクティベートする必要はありません。
40072	利用可能なテナントの上限数を超えてアクティベートをしようとした。	追加で必要なライセンスをお申し込みのうえ、アクティベートしてください。
40073	アクティベートしていないテナントに対してアクティベートを無効化しようとした。	アクティベート済みのテナントのテナントIDを指定してください。
40412	存在しないテナントIDを指定した。	正しいテナントIDを指定してください。
40482	存在しないライセンスキーを指定した。	正しいライセンスキーを指定してください。

認証方式

拡張版SPLATS APIで拡張機能を利用する際には、以下の2つの認証情報をリクエストヘッダーに含める必要があります。

ヘッダー名	項目	説明
Authorization	Bearer {ACCESS_TOKEN}	API認証・認可用のアクセストークンです。アクセストークンの発行方法に従い取得したアクセストークンをヘッダーに含めてください。どのテナントへのリクエストか、また許可されているかを確認するために必要です。
License-Key	{LICENSE_KEY}	当社より発行された拡張機能利用のためのライセンスキーです。リクエストの対象テナント（アクセストークンを発行したテナント）は、事前にこのライセンスキーでアクティベートされている必要があります。

ヘッダー名

項目

説明

Authorization

Bearer {ACCESS_TOKEN}

API認証・認可用のアクセストークンです。
アクセストークンの発行方法に従い取得したアクセストークンをヘッダーに含めてください。
どのテナントへのリクエストか、また許可されているかを確認するために必要です。

License-Key

{LICENSE_KEY}

当社より発行された拡張機能利用のためのライセンスキーです。
リクエストの対象テナント（アクセストークンを発行したテナント）は、事前にこのライセンスキーでアクティベートされている必要があります。