Instâncias
Criar uma instância
Cria uma instância e retorna o segredo HMAC do webhook.
API key
Escopo write
Exemplo de requisição
curl -X POST "https://seu-dominio/instances" \
-H "x-api-key: $VERTICE_API_KEY" \
-H "content-type: application/json" \
-d '{"name":"Atendimento","webhookUrl":"https://seu-sistema.com/hooks/whatsapp"}'
const response = await fetch('https://seu-dominio/instances', {
method: 'POST',
headers: {
'x-api-key': process.env.VERTICE_API_KEY ?? '',
'content-type': 'application/json',
},
body: JSON.stringify({
"name": "Atendimento",
"webhookUrl": "https://seu-sistema.com/hooks/whatsapp"
}),
});
const payload = await response.json();
console.log(payload);
Entenda
Conceituação
Cria uma instância e retorna o segredo HMAC do webhook. Guarde o segredo agora: ele não aparece novamente em claro.
Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.
Corpo JSON. Os campos abaixo são exemplos; campos marcados como obrigatórios precisam ser enviados.
Contrato
Atributos
Header
x-api-key
string
obrigatório
API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.
content-type
string
obrigatório
application/json.
Body
name
string
obrigatório
Nome exibido do recurso, contato, enquete ou grupo.
webhookUrl
string
opcional
URL HTTPS que receberá os eventos assinados. HTTP/localhost só em desenvolvimento.
Payload
Request Body
{
"name": "Atendimento",
"webhookUrl": "https://seu-sistema.com/hooks/whatsapp"
}
Contrato
201
Resposta
{
"data": {
"id": "inst_...",
"name": "Atendimento",
"status": "created",
"webhookSecret": "whsec_..."
}
}
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.
409
Instância não conectada ou conflito de estado.