Visão geral
A API REST do Rouxinol permite integrar seus sistemas com os dados da sua conta: agentes, conexões, contatos, equipes, URAs, formulários e o histórico de chamadas.
Base URL
Todos os endpoints da API pública ficam sob o prefixo:
/api/v1
Autenticação
Toda a API v1 exige um token OAuth2. Veja como obtê-lo em Autenticação.
:::tip Testando os exemplos de curl
Todos os exemplos de curl desta documentação usam as variáveis $ROUXINOL_URL e $ROUXINOL_TOKEN. Exporte as duas no seu terminal antes de copiar e colar qualquer exemplo — o passo a passo está em Autenticação.
:::
Formato das respostas
As respostas são sempre em JSON. Recursos de listagem (index) retornam os registros paginados; recursos individuais (show, store, update) retornam o objeto diretamente.
Paginação e filtros
Os endpoints de listagem aceitam, de forma consistente:
| Parâmetro | Descrição |
|---|---|
page | Página atual. |
per_page | Itens por página (padrão: 25). |
search | Busca textual (geralmente pelo campo name). |
is_active | Filtra por registros ativos/inativos, quando aplicável. |
Cada recurso pode ter filtros adicionais próprios — eles estão documentados na página de cada um.
Multi-tenant
Cada aplicativo (App OAuth) pertence a uma conta (tenant). Todos os registros retornados e criados pela API são automaticamente restritos à conta dona do token usado na requisição — não é possível ler ou escrever dados de outra conta através da API.