Admin
Visão agregada da plataforma
Visão da plataforma com workspaces, usuários, instâncias, MRR e distribuição por plano e status.
Chave mestra
Plataforma
Exemplo de requisição
curl -X GET "https://seu-dominio/admin/overview" \
-H "x-api-key: $VERTICE_API_KEY"const response = await fetch('https://seu-dominio/admin/overview', {
method: 'GET',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
},
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Visão da plataforma com workspaces, usuários, instâncias, MRR e distribuição por plano e status.
Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.
Contrato
Atributos
Header
x-api-key
string
obrigatório
Chave mestra da plataforma. Não distribua a clientes.
Contrato
200
Resposta
{
"data": {
"id": "..."
}
}Respostas de sucesso são envelopadas em data.
Erros comuns
400
Corpo, query ou parâmetro inválido. A resposta traz error.code e error.message.
401
Credencial ausente, inválida ou sessão expirada.
403
Escopo insuficiente, IP não autorizado ou workspace suspenso.