Comece por aqui

URL base, cabeçalhos de autenticação e de workspace, e como testar as chamadas no navegador.

Esta referência lista todas as rotas da API da Vozko, agrupadas por recurso, com os parâmetros, os corpos, as respostas e os códigos de erro de cada uma. Para entender os conceitos antes, leia os guias.

URL base

https://api.vozkoia.com

Todas as rotas desta referência partem desse endereço, com HTTPS. As conexões WebSocket usam wss://api.vozkoia.com. Não há ambiente de testes; veja URL base e ambientes.

Autenticação

Quase todas as rotas pedem o token de login no cabeçalho Authorization:

Authorization: Bearer SEU_ACCESS_TOKEN

Obtenha o token com POST /auth/login (veja Autenticação) e renove-o com POST /auth/refresh. As três rotas de envio e leitura da API de e-mail transacional aceitam, no lugar do token, a chave de API do workspace (wsk_). As rotas públicas, como o login, não pedem credencial.

Workspace

Envie o workspace da chamada no cabeçalho X-Workspace-ID, e opcionalmente um departamento em X-Department-ID:

X-Workspace-ID: SEU_WORKSPACE_ID
X-Department-ID: SEU_DEPARTMENT_ID

Os workspaces do usuário vêm de GET /workspaces. Sem o cabeçalho, vale o workspace padrão do usuário. Veja Workspaces e departamentos.

Teste no navegador

Cada rota desta referência tem um painel para enviar a chamada de verdade:

  1. Faça login com POST /auth/login pelo painel da própria rota de login, ou com curl, e copie o accessToken da resposta.
  2. Abra a rota que quer testar e preencha o campo de autenticação (BearerAuth) com a palavra Bearer, um espaço e o token: Bearer eyJhbGciOi....
  3. Preencha os parâmetros da rota e envie.

O painel ainda não tem um campo para X-Workspace-ID, então as chamadas feitas por ele valem para o workspace padrão do usuário. Para testar em outro workspace, use curl com o cabeçalho.

As chamadas feitas pelo painel agem sobre dados reais, como qualquer outra. Prefira um usuário cujo workspace padrão seja de testes.

Próximas páginas