reseller
GET /v1/reseller/overview
Everything you have — every URL, credential and setting, in one read.
Autenticação
Envie uma chave de API como um token de portador. A chave deve ter a permissão reseller.view; uma chave sem ela é recusada com 403, e não 404.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/reseller/overview \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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`.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | 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… |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
program | ResellerOverviewProgram | Sim | — |
panel | ResellerOverviewPanel | Sim | — |
mail | ResellerOverviewMail | Sim | — |
dns | ResellerOverviewDns | Sim | — |
api | ResellerOverviewApi | Sim | — |
support | ResellerOverviewSupport | Sim | — |
commerce | ResellerOverviewCommerce | Sim | — |
languages | ResellerOverviewLanguages | Sim | — |
notifications | ResellerOverviewNotifications | Sim | — |
clients | ResellerOverviewClients | Sim | — |
Erros que este endpoint pode retornar
401 · 403 · 404 · 429