reseller
GET /v1/reseller/overview
Everything you have — every URL, credential and setting, in one read.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/reseller/overview \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
The reseller reference card: the address your clients sign in at, the nameservers you hand them, your sending domain, your API base and key counts, where your clients' support goes, which product lines you sell, how many languages their panel offers, and how many client accounts you run. Every block carries the route that changes it, and the gaps (`gateway_gap`, `invoicing_gap`, `support.gap`) are reported as booleans so a screen can say what is missing rather than render a blank field. Requires `reseller.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
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 r… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
program | ResellerOverviewProgram | はい | — |
panel | ResellerOverviewPanel | はい | — |
mail | ResellerOverviewMail | はい | — |
dns | ResellerOverviewDns | はい | — |
api | ResellerOverviewApi | はい | — |
support | ResellerOverviewSupport | はい | — |
commerce | ResellerOverviewCommerce | はい | — |
languages | ResellerOverviewLanguages | はい | — |
notifications | ResellerOverviewNotifications | はい | — |
clients | ResellerOverviewClients | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 429