ORIGEMSeu ecossistemaERP · BI · Secretaria
INTEGRATION API · V1 ESTÁVEL
Seu ecossistema
conectado ao Colabore.
Uma superfície criada para ERPs, secretarias, sistemas legados e ferramentas de BI integrarem dados escolares com contrato versionado, isolamento por rede e rastreabilidade de ponta a ponta.
1.0.0 contrato versionado20 operações homologáveisREST JSON + HTTPS
ROTA DE INTEGRAÇÃOUma chamada. Quatro controles.
AUTORIZAÇÃOAcesso com contextoRede · papel · escopo
PROCESSAMENTOAPI ColaboreIntegration API v1
RETORNODados + eventosMercúrio · resposta rastreável
CHEGADA
GET /api/integration/v1/alunos200 · application/jsonCONHECER É PÚBLICO. OPERAR É CONTROLADO.
Duas portas.
Uma fronteira clara.
O conteúdo institucional não precisa de cadastro. O material que permite executar testes ou alcançar dados de uma rede só aparece depois da aprovação técnica e comercial.
CONTEÚDO ABERTO
Tudo para avaliar a integração.
Visão de produto
Casos de uso, arquitetura e capacidades da Integration API v1.
Padrões do contrato
REST + JSON, versionamento, paginação, erros e compatibilidade.
Catálogo funcional
Recursos e operações disponíveis, sem dados de nenhuma rede.
Segurança por desenho
Isolamento, escopos, auditoria, LGPD e boas práticas.
CATÁLOGO FUNCIONAL
Integre o necessário.
Sem acoplar às telas.
A superfície pública mostra o que o v1 resolve. Schemas completos, exemplos executáveis e o ambiente de teste permanecem no portal credenciado.
INTEGRATION API V1 · CADASTROS
Unidades e alunos
Consulte a estrutura da rede e a matrícula ativa com paginação previsível e recorte automático por rede.
Contrato público · execução autenticada/api/integration/v1/unidadesLista escolas da rede/api/integration/v1/unidades/{id}Consulta uma unidade/api/integration/v1/alunosLista alunos e matrícula ativa/api/integration/v1/alunos/{id}Consulta um alunoO catálogo apresenta caminhos e finalidades. Modelos de dados, exemplos completos e testes “Try it” exigem acesso ao portal técnico.
SEGURANÇA EM CAMADAS
A credencial não
abre a rede inteira.
Cada chamada atravessa identidade, papel, plano contratado, alcance do dado e isolamento no banco. A camada de baixo não confia apenas na de cima.
Uma rede por chave
Não existe consulta entre redes. Se um parceiro atende duas organizações, recebe duas credenciais independentes.
Leitura e escrita separadas
O padrão é somente leitura. Transferências, lotes e replays exigem escopo de escrita explicitamente aprovado.
Dado pessoal minimizado
CPF sai mascarado e dados de saúde, psicossociais e pedagógicos sensíveis ficam fora do contrato público.
QUEM PRECISA DE CREDENCIAL?
O acesso acompanha
a responsabilidade.
Há credenciais diferentes para pessoas e sistemas. O desenvolvedor entra no portal; a integração usa uma chave própria, revogável e vinculada a uma única rede.
PerfilAcessoO que pode usar
01Visitante e time avaliadorSem credencialVisão geral, padrões, segurança e catálogo funcional.
02Desenvolvedor de parceiro aprovadoLogin do portalOpenAPI, Postman, guias completos e sandbox homologado.
03Sistema integradorChave de máquinaChamadas à API de uma única rede, com papel, escopo e limite próprios.
04Gestor da redeConta administrativaCriação, expiração, revogação e auditoria das chaves da organização.
05Operação e DPOAcesso restritoProdução, evidências, incidentes e finalidades de acesso a dados sensíveis.
JORNADA DE INTEGRAÇÃO
Da descoberta
à produção.
O acesso cresce à medida que a integração comprova segurança, correção e isolamento.
Descobrir
Leia a visão pública e valide o caso de uso.
Solicitar
Identifique a rede, o sistema e o responsável técnico.
Construir
Receba portal, OpenAPI e sandbox com dados sintéticos.
Homologar
Execute as 24 provas do pacote de conformidade.
Operar
Ative chaves de produção, monitoramento e rotação.
PRÓXIMO PASSO
Conecte seu sistema.
Preserve cada contexto.
Conte qual sistema precisa integrar, a rede atendida e se o primeiro fluxo é de leitura, sincronização, eventos ou escrita.