URL base e ambientes

O endereço da API, o endereço das conexões em tempo real e os ambientes disponíveis.

URL base

Todas as rotas da referência partem deste endereço, sempre com HTTPS:

https://api.vozkoia.com

Por exemplo, o login é POST https://api.vozkoia.com/auth/login.

As conexões de tempo real usam o mesmo endereço com o esquema de WebSocket:

wss://api.vozkoia.com

Ambientes

Existe um único ambiente, o de produção. Não há ambiente de testes (sandbox) hoje.

Isso quer dizer que toda chamada age sobre dados reais do workspace: mensagens e e-mails enviados chegam às pessoas, e envios cobrados consomem o saldo do workspace. Para testar uma integração:

  • crie um workspace separado para testes e use o id dele em X-Workspace-ID;
  • envie mensagens e e-mails apenas para contatos e endereços da sua equipe;
  • use um usuário dedicado à integração, com só as permissões necessárias.

Requisições

  • Use HTTPS e JSON em UTF-8. Envie Content-Type: application/json nas requisições com corpo.
  • O corpo de uma requisição pode ter até 1 MiB (1.048.576 bytes). Rotas de envio de arquivos e de importação aceitam corpos maiores. Um corpo maior que o limite recebe, em geral, 413 com o código body_too_large e o limite em bytes em details.maxBytes.
  • Chame a API a partir do seu servidor. O navegador só aceita respostas da API em páginas dos domínios autorizados (CORS), como o próprio aplicativo.

Did this page help you?