Instâncias

Gerar link/iframe temporário de conexão

Gera um link HMAC de 15 minutos para uma página pública de conexão, além do trecho de iframe para incorporar em sites de clientes.

API key Escopo write

Exemplo de requisição

curl -X POST "https://seu-dominio/instances/:id/connect-link" \
  -H "x-api-key: $VERTICE_API_KEY"

const response = await fetch('https://seu-dominio/instances/:id/connect-link', {
  method: 'POST',
  headers: {
  'x-api-key': process.env.VERTICE_API_KEY ?? '',
  },
});

const payload = await response.json();
console.log(payload);

POST /instances/{id}/connect-link

API key

Entenda

Conceituação

Gera um link HMAC de 15 minutos para uma página pública de conexão, além do trecho de iframe para incorporar em sites de clientes.

Respostas de sucesso seguem { "data": ... }; erros seguem { "error": { "code", "message" } }. Operações de escrita exigem escopo write quando autenticadas por API key.

Contrato

Atributos

2 campos

Header

x-api-key string obrigatório

API key do workspace (vtc_live_...). Também aceita Authorization: Bearer.

Path

id string obrigatório

ID da instância.

Contrato

Resposta

200

{
  "data": {
    "ok": true
  }
}

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.

404 Recurso não encontrado ou pertence a outro workspace.

409 Instância não conectada ou conflito de estado.