Visão geral
Comece a integrar com a API de Integração da Principia (Onboarding IES API).
Bem-vindo à documentação da API de Integração da Principia. Aqui você encontra o passo a passo para integrar, a referência completa das rotas (com a possibilidade de testar cada uma) e um assistente de IA para tirar dúvidas.
Por onde começar
Primeiros passos
Do zero à sua primeira chamada com sucesso.
Autenticação
Como obter e usar sua chave institucional.
Fluxo de integração
O caminho completo do caso de uso principal.
Rotas da API
Todas as rotas, com exemplos e playground.
O que dá para fazer com a API
A API de Integração permite que a IES (instituição de ensino) troque dados com a Principia de forma automatizada:
- Parcelas: incluir parcelas para cobrança, consultar parcelas originais e gerar links de pagamento.
- Alunos: incluir alunos.
- Processamento: acompanhar o status dos lotes enviados (a inclusão é assíncrona).
- Liquidações: consultar as liquidações de parcelas.
- Acordos: consultar acordos.
- Importação: conferir os itens enviados (alunos e parcelas).
- Extratos: obter extratos de Gestão, Receita Garantida e Cessões de Parcelas.
- Login via SSO: levar o aluno do portal da IES para o portal da Principia sem precisar logar de novo.
Assistente de IA
Está com pressa? Use o botão Perguntar à IA no canto inferior direito. Ele responde com base nesta documentação e ajuda a localizar a rota ou a seção que você procura.