ブランド識別子を変更¶
POST /api/v1/workspace/change_brand_key
概要¶
指定したワークスペースが使用するサイトブランドを一括設定します。
呼び出し前の準備と使用手順¶
External API の書き込み権限が必要です。まず対象サイトで許可されているブランド識別子を確認し、ワークスペース一覧から有効な UUID を取得します。送信後はワークスペース詳細を個別に呼び出して content.brandKey を確認します。見つからない UUID と削除済みのワークスペースはスキップされ、レスポンスには項目ごとの更新結果は返りません。
DF_EXTERNAL_API_URL、DF_EXTERNAL_ACCESS_KEY、DF_EXTERNAL_SECRET_KEY を設定してからサンプルを実行します。サンプルのワークスペース UUID、ブランド、設定値は実際の値に置き換えてください。署名バージョンは v20240417 です。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| X-Df-SVersion | string | 署名バージョン。以下のサンプルでは v20240417 を使用します。 例: v20240417取得・記入方法: サンプルどおりに入力します。署名アルゴリズムに対応します。 |
|
| X-Df-Access-Key | string | Y | リクエスト AK 情報 例: <access-key>取得・記入方法: External API 管理者から割り当てられます。 |
| X-Df-Signature | string | Y | 署名情報 例: <hex-signature>取得・記入方法: サンプルに従い、メソッド、nonce、パス、タイムスタンプ、および実際に送信する JSON バイトに対して HMAC-SHA256 を計算します。 |
| X-Df-Timestamp | string | Y | リクエスト時のタイムスタンプ 例: 1785456000取得・記入方法: 呼び出し時点の現在の Unix 秒を入力します(例: date +%s を実行)。 |
| X-Df-Nonce | string | Y | リクエスト時に生成する一時コード 例: b53b47e12e514616ad8cb1f17cb66dce取得・記入方法: リクエストごとに新しいランダム値を生成します(例: uuid.uuid4().hex)。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| brandKey | string | Y | サイトで許可されているブランド識別子。例えば一部のサイトでは guance または truewatch が許可されています。空文字列を渡すと現在のサイトのデフォルトブランドを使用します。 null 許容: False 例: truewatch取得・記入方法: 対象サイトの管理者から有効なブランド識別子を取得してください。 |
| workspaceUUIDs | array | Y | ワークスペース UUID の配列。空の配列ではワークスペースは更新されません。 null 許容: False 例: ["wksp_example"]取得・記入方法: ワークスペース一覧の content.data[].uuid から調整対象のワークスペースをコピーします。空でない配列を送信することを推奨します。 |
パラメータ補足説明¶
対象サイトで割り当てられた External API 署名資格情報を使用します。
リクエスト例¶
import hmac
import json
import os
import time
import uuid
import requests
server = os.environ["DF_EXTERNAL_API_URL"].rstrip("/")
path = "/api/v1/workspace/change_brand_key"
method = "POST"
body = json.dumps({'brandKey': 'truewatch', 'workspaceUUIDs': ['wksp_example']}, ensure_ascii=False, separators=(',', ':')).encode('utf-8')
timestamp = str(int(time.time()))
nonce = uuid.uuid4().hex
payload = f"{method} {nonce} {path} {timestamp} ".encode("utf-8") + body
signature = hmac.digest(os.environ["DF_EXTERNAL_SECRET_KEY"].encode(), payload, "sha256").hex()
headers = {
"X-Df-Access-Key": os.environ["DF_EXTERNAL_ACCESS_KEY"],
"X-Df-Timestamp": timestamp,
"X-Df-Nonce": nonce,
"X-Df-SVersion": "v20240417",
"X-Df-Signature": signature,
"Content-Type": "application/json",
}
response = requests.request(method, server + path, headers=headers, data=body, timeout=15)
response.raise_for_status()
data = response.json()["content"]
レスポンス¶
HTTP 200、application/json。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 成功時のレスポンスは {} で、項目ごとの結果はありません。 |
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | フィールドの型、必須指定、または制約がパラメータ表と一致しない | リクエストフィールドの検証に失敗しました。メッセージにフィールドまたはルールが示されます。 | フィールド、型、制約を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラーです。 | content の reason、line、column を確認して修正してください。 |
| 400 | ft.JsonFormatError | JSON 形式は有効だが、Body 全体が JSON オブジェクトではない | JSON 形式エラーです。 | パラメータを波括弧で囲んだ JSON オブジェクト内に配置してください。 |
| 406 | ft.InvalidBrandKey | ブランド識別子が現在のサイトの許可セットに含まれていない | ブランド識別子が無効です。 | サイト管理者に有効なブランド識別子を確認するか、空文字列を使用してデフォルトに戻してください。 |