Skip to content

Documentação — Instituições externas

Bem-vindo à documentação técnica voltada a integração com a API do ecossistema de instituições externas. Este site concentra referências de endpoints, contratos de entrada e saída, e requisitos de autenticação para quem consome ou mantém integrações.

O que você encontra aqui

  • Referência da API — rotas, parâmetros, exemplos de respostas e códigos HTTP relevantes.
  • Contexto operacional — prefixos de URL, autenticação e formato geral das respostas, para reduzir ambiguidade na integração.

Público e pré-requisitos

A documentação assume familiaridade com HTTP/REST, JSON e o fluxo de autenticação por token (por exemplo, Bearer via header Authorization). Detalhes específicos de cada rota estão na página de referência da API.

Próximos passos

Consulte a seção API no menu para a referência dos endpoints: Instituições, Simulados (incluindo /api/admin-ext/simulados) e Questões — com token Bearer e escopo de instituição onde aplicável.

Esta documentação é atualizada conforme a evolução da API; em caso de divergência com o ambiente em produção, o comportamento do servidor prevalece.