API de Integração

FAQ

Perguntas frequentes sobre a integração.

A inclusão de parcelas é síncrona?

Não. A inclusão de parcelas e alunos é assíncrona: você envia um lote e acompanha o processamento pelas rotas de status. Não assuma conclusão na resposta imediata.

Qual versão de rota devo usar?

Sempre a mais recente disponível (ex.: v3/liquidacoes, v2/acordos). As versões anteriores são mantidas apenas por compatibilidade.

Como evito duplicar parcelas em um reenvio?

Use identificadores estáveis (como id_agrupador). Assim, reenvios do mesmo lote não geram duplicidade.

Onde testo sem afetar dados reais?

No ambiente de staging. Cada ambiente tem sua própria chave.

Posso testar as rotas sem escrever código?

Sim. Cada página das Rotas da API tem um playground para enviar a requisição direto da documentação.

Não achei o que preciso. E agora?

Use o botão Perguntar à IA (canto inferior direito): ele busca em toda esta documentação. Se ainda assim não resolver, fale com o seu contato na Principia.

Nesta página