reseller
PATCH /v1/reseller/languages
Choose the languages and the default your clients start in.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.manage 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PATCH https://api.zinndigital.com/v1/reseller/languages \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
locales replaces the list your clients may choose from; send an empty array to go back to offering every language. default_locale is what a new client account starts in and must be one you offer — your clients can still change their own language afterwards. A code we do not ship is refused rather than dropped. Requires reseller.manage.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404… |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
locales | string[] | いいえ | Replaces the list your clients may choose from. An empty array returns you to offering every language. |
default_locale | string | いいえ | Empty returns to the platform default. |
switcher | boolean | いいえ | Whether the language control renders in your clients' panel. |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
languages | ResellerLanguage[] | はい | — |
offers_all | boolean | はい | You have made no choice, so your clients get every language. |
offered_count | integer | はい | — |
total_count | integer | はい | — |
default_locale | string | はい | What a new client account starts in. Empty means the platform default. |
switcher | boolean | いいえ | Whether the language control renders in your clients' panel at all. false shows every client the panel in default_locale; it never removes their right to change their own… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422 · 429