Documentação da API

Toda instituição tem sua própria documentação interativa da API, disponível em /docs/ a partir do endereço da sua Eduvem - por exemplo, https://love.eduvem.com/docs/. É o material que o time técnico responsável pela integração (RH, ERP, BI ou qualquer sistema externo) vai usar para conhecer e testar a API antes de escrever qualquer código.

O que você encontra lá

A documentação reúne todos os endpoints da API de integração: parâmetros aceitos, esquemas de requisição e de resposta, e os escopos exigidos por cada chamada. A página é interativa - dá para expandir qualquer endpoint, preencher os parâmetros e enviar a requisição direto pelo navegador, usando um token real, sem precisar de Postman nem de nenhuma outra ferramenta externa.

Onde encontrar o link

Na aba Integrações das configurações da instituição (Instituição > Integrações), a seção Configurações da API para Integrações traz:

• O link Documentação da API, que abre o /docs/ da sua instituição.
• A URL da API, já pronta para copiar - o endereço base usado em toda chamada de integração.

Dica

Cada instituição tem sua própria documentação, no seu próprio domínio. Se você administra ou integra mais de uma Eduvem, confirme sempre qual /docs/ está usando - o de cada instituição é diferente.

Autenticação

Para testar uma chamada direto na documentação interativa - ou para configurar uma integração de verdade - você precisa de um token da API válido. A criação, a revogação e os escopos dos tokens são gerenciados na mesma aba Integrações: veja Tokens da API de integração. Sem um token, a documentação continua navegável e cada endpoint fica visível, mas o botão de enviar a requisição retorna erro de autenticação.

Veja também

• Tokens da API de integração