ORIGINYour ecosystemERP · BI · Education office
INTEGRATION API · STABLE V1
Your ecosystem
connected to Colabore.
A stable surface for ERPs, education departments, legacy systems, and BI tools to integrate school data through a versioned contract, tenant isolation, and end-to-end traceability.
1.0.0 versioned contract20 certifiable operationsREST JSON + HTTPS
INTEGRATION ROUTEOne call. Four controls.
AUTHORIZATIONContext-aware accessTenant · role · scope
PROCESSINGColabore APIIntegration API v1
RETURNData + eventsMercury · traceable response
ARRIVAL
GET /api/integration/v1/alunos200 · application/jsonDISCOVERY IS PUBLIC. OPERATIONS ARE CONTROLLED.
Two entry points.
One clear boundary.
Institutional content requires no registration. Materials that allow testing or access to a school network's data are available only after technical and commercial approval.
OPEN CONTENT
Everything needed to evaluate the integration.
Product overview
Use cases, architecture, and capabilities of Integration API v1.
Contract standards
REST + JSON, versioning, pagination, errors, and compatibility.
Functional catalog
Available resources and operations, without data from any school network.
Security by design
Tenant isolation, scopes, auditing, privacy, and good practices.
FUNCTIONAL CATALOG
Integrate what matters.
Stay independent from screens.
The public surface shows what v1 can do. Complete schemas, executable examples, and the test environment remain in the credentialed portal.
INTEGRATION API V1 · RECORDS
Schools and students
Query the school network structure and active enrollments with predictable pagination and automatic tenant scoping.
Public contract · authenticated execution/api/integration/v1/unidadesList schools in the network/api/integration/v1/unidades/{id}Retrieve a school/api/integration/v1/alunosList students and active enrollments/api/integration/v1/alunos/{id}Retrieve a studentThe catalog presents paths and purposes. Data models, complete examples, and “Try it” tests require access to the technical portal.
LAYERED SECURITY
A credential never
opens the entire network.
Every call crosses identity, role, contracted plan, data reach, and database isolation. No lower layer relies solely on the layer above it.
One network per key
There are no cross-network queries. A partner serving two organizations receives two independent credentials.
Read and write are separate
Read-only is the default. Transfers, batches, and replays require an explicitly approved write scope.
Personal data is minimized
Brazilian tax IDs are masked, while health, psychosocial, and sensitive education data stay outside the public contract.
WHO NEEDS CREDENTIALS?
Access follows
accountability.
People and systems use different credentials. Developers sign in to the portal; integrations use their own revocable key, bound to a single school network.
ProfileAccessAvailable resources
01Visitor and evaluation teamNo credentialsOverview, standards, security, and functional catalog.
02Approved partner developerPortal loginOpenAPI, Postman, complete guides, and certified sandbox.
03Integration systemMachine keyAPI calls for one school network, with dedicated role, scope, and rate limit.
04School network administratorAdmin accountCreate, expire, revoke, and audit the organization's keys.
05Operations and DPORestricted accessProduction, evidence, incidents, and purposes for sensitive-data access.
INTEGRATION JOURNEY
From discovery
to production.
Access expands as the integration demonstrates security, correctness, and tenant isolation.
Discover
Review the public overview and validate the use case.
Request
Identify the school network, system, and technical owner.
Build
Receive portal access, OpenAPI, and a synthetic-data sandbox.
Certify
Run the 24 tests in the conformance pack.
Operate
Activate production keys, monitoring, and rotation.
NEXT STEP
Connect your system.
Preserve every context.
Tell us which system needs to integrate, which school network it serves, and whether the first flow involves reading, synchronization, events, or writes.