Teste dentro da documentação
Preencha parâmetros, execute a requisição e consulte a resposta sem montar um cliente separado para a primeira validação.
Funcionalidade OmniSmart · Documentação interativa da API
Uma API que sua equipe consegue consultar, testar e integrar
A documentação fica dentro da plataforma, organiza endpoints por finalidade e permite executar requisições com o token do usuário. Exemplos de código e coleção Postman reduzem o caminho entre descoberta e primeira integração.
Teste de endpoints no navegadorExemplos em três linguagensColeção Postman exportável
apiOmniSmart APIDOCUMENTAÇÃO INTERATIVA
PTENdark_mode
GET
/v1/reports/telephony/teamslockBearer token
Relatório de equipes — telefonia
Retorna dados consolidados e analíticos das equipes no período informado.
Parâmetros
start_datestring · required
end_datestring · required
deployed_codeExportar Postman
cURLTypeScriptPython200 OK
curl --request GET \ --url 'https://api.omnismart.com.br/v1/reports/telephony/teams' \ --header 'Authorization: Bearer ••••••••'
33 endpoints18 relatórios e 15 controladores documentados
3 formatoscURL, TypeScript e Python
2 idiomasPortuguês e inglês na interface
1 cliqueExportação de coleção para Postman
Experiência para desenvolvedores
Documentação útil responde o que chamar, como autenticar e o que esperar.
Em vez de uma lista solta de rotas, a documentação apresenta parâmetros, exemplos, paginação, respostas e erros no contexto de cada endpoint. A equipe técnica pode validar uma chamada antes de escrever a integração definitiva.
Autenticação contextual
O token do usuário autenticado pode ser utilizado na experiência de teste, respeitando acesso e escopo disponíveis.
Exemplos prontos
Copie exemplos equivalentes em cURL, TypeScript e Python para acelerar protótipos e implementação.
Exportação para Postman
Gere uma coleção com endpoints e estrutura inicial para continuar testes no ambiente da equipe.
Relatórios e controladores
Navegue entre consultas de dados e operações disponíveis, com agrupamento e descrição de finalidade.
Interface bilíngue
Consulte a experiência em português ou inglês, incluindo descrições e elementos de navegação.
Da descoberta ao protótipo
Encontre o endpoint, valide a chamada e leve o exemplo para o projeto
A documentação reduz trabalho exploratório, mas a integração continua exigindo regras de negócio, segurança, limites e tratamento de falhas.
Defina o caso de uso
Especifique o dado ou a ação necessária e quem poderá utilizar a integração.
Localize o endpoint
Navegue pela categoria adequada e revise método, parâmetros, resposta e paginação.
Execute um teste
Use dados controlados para validar autenticação, formato e comportamento esperado.
Copie ou exporte
Leve o exemplo da linguagem escolhida ou gere uma coleção para o Postman.
Implemente com governança
Adicione armazenamento seguro, logs, limites, retentativas e tratamento de exceções.
Impacto na operação
O que muda na prática
A integração avança com menos tentativa quando documentação, execução e exemplos usam a mesma referência técnica.
Primeira chamada mais rápida
A equipe confirma autenticação, parâmetros e resposta antes de construir toda a camada de integração.
Diagnóstico mais objetivo
Uma execução reproduzível ajuda a separar erro de acesso, payload, regra ou implementação.
Menos tradução manual
Exemplos em linguagens usuais aproximam a documentação do código que será produzido.
Alinhamento entre equipes
Produto, operação e desenvolvimento podem apontar para o mesmo endpoint e para a mesma resposta esperada.
Para quem faz sentido
Uma experiência técnica para quem precisa conectar sistemas
Desenvolvedores e arquitetosTimes de integraçãoProduto e operaçõesParceiros de tecnologiaClientes com ERP ou CRMEquipes de dados e BI
Perguntas frequentes
Entenda melhor
É uma documentação em que o usuário consulta detalhes do endpoint e também pode preencher parâmetros e executar uma requisição de teste no próprio ambiente.
A experiência documentada oferece exemplos em cURL, TypeScript e Python para os endpoints disponibilizados.
Sim. A documentação permite gerar uma coleção para continuar a exploração e os testes no Postman.
A documentação reúne endpoints de relatórios e controladores conforme a disponibilidade da plataforma, incluindo consultas relacionadas a chamadas e equipes.
Não. Ela acelera descoberta e prototipação, mas uma integração de produção ainda exige arquitetura, segurança, tratamento de falhas e conhecimento do processo.
Fale com a OmniSmart
Mostre o que seus sistemas precisam trocar com a OmniSmart
Mapeie dados, eventos, ações e responsabilidades para identificar os endpoints e o desenho de integração adequados.
Converse com um especialista
Conte o básico sobre seu cenário.