セッションの初期化 - Kameleoon Documentation

GET

init

Initialize session

curl --request GET \
  --url https://api.products.kameleoon.com/init

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/init",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.products.kameleoon.com/init"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.products.kameleoon.com/init")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "did": "<string>",
  "seance": "<string>",
  "currency": "<string>",
  "email_collector": true,
  "has_email": true,
  "recommendations": true,
  "lazy_load": true,
  "auto_css_recommender": true,
  "cms": "<string>",
  "snippets": [
    {
      "id": 123,
      "name": "<string>",
      "code": "<string>",
      "priority": 123
    }
  ],
  "search": {
    "enabled": true,
    "landing": "<string>",
    "type": "<string>",
    "settings": {}
  }
}

Product Recommendation API の他の API メソッドを使用する前に、init API を呼び出します。初期化プロセスは現在のユーザー識別子を受け入れ、プロジェクト設定とユーザー設定をリクエストします。

いつ初期化するか

プラットフォームによって、init を実行する必要があるタイミングの要件が異なります。

cURL: ページがレンダリングされるたびに初期化します。
Web: ページが開かれるたびに初期化します(シングルページアプリケーションを含む)。
iOS または Android: アプリケーションが起動するたびに初期化します。

新しいデバイスでの初回起動時には、デバイス識別子がありません。デバイス ID を生成するには、デバイス ID を指定せずに init メソッドを呼び出します。Kameleoon Web Experimentation を使用するバックエンドレコメンデーションロジックの場合は、この API を呼び出し、ID を sid 用の KameleoonProducts_session_code クッキーと did 用の KameleoonProducts_device_id クッキーに保存します。

クエリパラメーター

パラメーター	型	必須	説明
`shop_id`	String	True	ストアキー。Kameleoon アプリの Recommendations > Settings > Store settings で確認できます。キーについては、カスタマーサクセスマネージャーにもお問い合わせいただけます。
`did`	String	False	デバイス ID。デバイス ID が既に存在する場合は、ここに指定してください。`did` を指定しない場合、API は Kameleoon データベース内で新しい ID を生成します。生成された ID は、それ以降のすべてのリクエストでデバイス ID として使用してください。
`sid`	String	True*	セッション ID は、現在のセッション中にユーザーに割り当てられた一時的な識別子です。一意の文字列でなければならず、新しいセッションが開始されるたびに再生成されます。最初の init リクエストには `sid` を含めないでください。`sid` は Kameleoon によって生成され、API レスポンスで返されます。リクエストで `sid` を指定し、それがシステム内に存在しない場合、エラーが発生します。

sid パラメーターは必須ですが、最初の初期化時には追加しないでください。システムがそれを生成し、レスポンス(seance として)で返します。生成後は、現在のセッション内のリクエストにはシステムが生成した sid を使用してください。

レスポンス

名前	型	説明
`did`	String	デバイス ID。以降のリクエストで使用するために保存してください。
`seance`	String	生成されたセッション ID(`sid`)。現在のセッション内のリクエストに使用してください。
`currency`	String	ショップのデフォルト通貨。
`email_collector`	Boolean	このショップでメールコレクター機能が有効かどうか。
`has_email`	Boolean	このセッションに既にメールアドレスが関連付けられているかどうか。
`recommendations`	Boolean	このショップで商品レコメンデーションが有効かどうか。
`lazy_load`	Boolean	このショップでレコメンデーションブロックが遅延読み込みされるかどうか。
`auto_css_recommender`	Boolean	Kameleoon がレコメンデーションブロックの CSS を自動的に挿入するかどうか。
`cms`	String	このショップに設定されている CMS/プラットフォームの識別子(存在する場合)。
`snippets`	Array of objects	Kameleoon アプリでこのショップに設定されたカスタム JavaScript スニペット。レコメンデーションブロックとともに挿入されます。各オブジェクトは `id`、`name`、`code`、`priority` を含みます。
`search`	Object	ショップの Search サービス設定。`enabled`、`landing`、`type`、`settings` を含みます。

クエリパラメータ

shop_id

string

必須

Store Key. Find this in Recommendations > Settings > Store settings in the Kameleoon app. Contact your Customer Success Manager for the key if necessary.

did

string

A device ID. If a device ID already exists, specify it here. If you don't specify a did, the API generates a new one. Use this generated ID as the device ID for all future requests.

sid

string

A session ID is a temporary identifier assigned to the user for the current session. Do not include sid on the first init request; Kameleoon generates and returns it (as seance) in the response. If a sid is specified and does not exist in the system, an error occurs.

レスポンス

200 - application/json

Session initialized. Verified against a live response on 2026-09-24; fields below reflect what the API actually returns, which is more than the did/seance pair described in the endpoint's prose.

did

string

The device ID. Store this for use on subsequent requests.

seance

string

The generated session ID (sid). Use it for requests within the current session.

currency

string

The shop's default currency symbol.

email_collector

boolean

Whether the email collector feature is enabled for this shop.

has_email

boolean

Whether an email address is already associated with this session.

recommendations

boolean

Whether product recommendations are enabled for this shop.

lazy_load

boolean

Whether recommendation blocks lazy-load on this shop.

auto_css_recommender

boolean

Whether Kameleoon automatically injects CSS for recommendation blocks.

cms

string

The CMS/platform identifier configured for this shop, if any.

snippets

object[]

Custom JavaScript snippets configured for this shop in the Kameleoon app, injected alongside recommendation blocks.

Show child attributes

object

The shop's Search service configuration.

Show child attributes

⌘I

Initialize session

curl --request GET \
  --url https://api.products.kameleoon.com/init

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.products.kameleoon.com/init",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.products.kameleoon.com/init"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.products.kameleoon.com/init")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "did": "<string>",
  "seance": "<string>",
  "currency": "<string>",
  "email_collector": true,
  "has_email": true,
  "recommendations": true,
  "lazy_load": true,
  "auto_css_recommender": true,
  "cms": "<string>",
  "snippets": [
    {
      "id": 123,
      "name": "<string>",
      "code": "<string>",
      "priority": 123
    }
  ],
  "search": {
    "enabled": true,
    "landing": "<string>",
    "type": "<string>",
    "settings": {}
  }
}

API

​いつ初期化するか

​クエリパラメーター

​レスポンス

クエリパラメータ

レスポンス

いつ初期化するか

クエリパラメーター

レスポンス