Skip to main content
Esta página reúne referências para equipes de tecnologia e desenvolvimento que desejam conhecer os recursos técnicos do VisuoLab e avaliar integrações com sistemas institucionais.
A documentação da API e parte dos materiais técnicos estão publicados externamente, em inglês. Antes de implementar uma integração, confirme a versão em uso e a disponibilidade dos recursos com a equipe responsável pela instalação.

​
Documentação disponível

Referência da API do VisuoLab

Consulte a documentação oficial da API para explorar os recursos e operações descritos na versão disponível. Ela é a referência para avaliar as possibilidades técnicas de integração.

Documentação técnica complementar

Acesse os materiais técnicos publicados no site do VisuoLab. Utilize-os como referência complementar às orientações de implantação desta documentação.

​
Antes de iniciar uma integração

Uma integração deve considerar não apenas o que a API documenta, mas também as particularidades da instalação institucional.
1

Defina o objetivo

Identifique os fluxos e dados que precisam ser integrados, quem utilizará a solução e quais resultados são esperados.
2

Confira os recursos documentados

Consulte a referência da API para verificar se as operações necessárias estão disponíveis na versão utilizada pela instituição.
3

Alinhe acesso, permissões e proteção de dados

Confirme com a equipe técnica as regras aplicáveis de autenticação, autorização, tratamento de informações pessoais e uso de ambientes de teste.
4

Valide antes de utilizar em produção

Planeje testes de integração, tratamento de falhas, monitoramento e manutenção conforme a implantação institucional.

​
Instalação e operação

Para conhecer a infraestrutura, os serviços e as etapas de implantação, consulte Instalação e configuração técnica. Se sua instituição planeja disponibilizar uma integração, alinhe previamente os requisitos com sua equipe técnica e, quando necessário, com a Levante Lab.

​
Evolução desta documentação

Nesta primeira etapa, mantemos as referências técnicas externas como fontes de consulta. Futuramente, poderemos reunir a documentação de endpoints no próprio Mintlify, caso exista uma especificação OpenAPI compatível e aprovada para publicação, com a devida revisão de versões, exemplos e requisitos de acesso.