Exemplo de requisição
curl -X GET "https://seu-dominio/partner/instances" \
-H "x-api-key: $VERTICE_API_KEY"const response = await fetch('https://seu-dominio/partner/instances', {
method: 'GET',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
},
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Lista instâncias de parceiro.
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.
Query
tenantId
string
opcional
Parâmetro de consulta.
Contrato
200
Resposta
{
"data": []
}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.