Documentação API
🔑 Permissão exigida: SSO, Cadastro, Usuários
A sigla API vem do termo em inglês _Application Programming Interface_ (Interface de Programação de Aplicações). Ela define um conjunto de rotinas, padrões e recursos que permitem a comunicação entre sistemas distintos, facilitando a integração com aplicações de software e plataformas web.
Finalidade da APIA API REST de relatórios da plataforma permite automatizar a extração de alguns relatórios disponíveis na interface, integrando esses dados diretamente aos seus sistemas internos.SSOCadastrUsuáriosEditarDados complementaresAcesso à APIAutenticação para utilização da API:
- Autentique-se informando o login e senha do usuário autorizado
- Um token de acesso com validade de 24 horas será retornado
- Utilize esse token no cabeçalho das requisições subsequentes aos endpoints da API
Documentação técnica
O conteúdo em PDF disponível, em anexo, inclui:
- Lista completa de endpoints disponíveis
- Esquemas de autenticação e headers obrigatórios
- Parâmetros aceitos e exemplos de payloads
- Respostas esperadas da API
Após a habilitação da API e o acesso à documentação técnica, é possível integrar os dados da plataforma de forma estruturada aos sistemas internos, viabilizando automações e análises personalizadas. Garantir as permissões apropriadas ao usuário e seguir as instruções descritas são etapas essenciais para o funcionamento adequado da integração.
- API Relatório - V4.pdf 800 kB Download