| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Contacts (contacts)
• Discuss (mail) • Employees (hr) |
| Community Apps Dependencies | Show |
| Lines of code | 4623 |
| Technical Name |
schoolos_api |
| License | OPL-1 |
| Website | https://bbtech.ae/ |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
•
Contacts (contacts)
• Discuss (mail) • Employees (hr) |
| Community Apps Dependencies | Show |
| Lines of code | 4623 |
| Technical Name |
schoolos_api |
| License | OPL-1 |
| Website | https://bbtech.ae/ |
This is a dependent SchoolOS application. It runs on top of the main SchoolOS app (the unified data model, roles and portals). Get the complete SchoolOS bundle - every module, every portal, every report - in a single license.
|
SchoolOS - REST API Gateway
A secure REST/JSON API for your SchoolOS data - scoped API keys | per-key rate limiting | signed outbound webhooks | full access audit log. Connect your SIS, BI tools, mobile back-ends and partner systems without ever exposing the database.
SchoolOS - REST API Gateway turns your SchoolOS instance into an integration platform. Issue narrowly-scoped API keys (read students, attendance, fees or academics - each toggled independently), throttle every key with a per-minute rate limit, and let external systems pull live data over a clean, versioned /api/v1 REST surface that returns predictable JSON. Outbound webhooks notify partner systems the moment a student enrols, attendance is recorded or a fee is paid - every payload signed with HMAC-SHA256 so the receiver can verify it. Each call is recorded in an immutable access log, and every key is scoped to a single school's company, so multi-school groups never leak data across branches. No raw database credentials, no XML-RPC sprawl - just a controlled, auditable API.
Who is this for?
- School IT teams integrating a third-party SIS or LMS
- BI / reporting teams pulling live data into dashboards
- Mobile-app back-ends serving parents and students
- Payment and finance partners reconciling fee data
- Government / regulator data-exchange integrations
- Odoo consultants building custom connectors
Key Benefits
Integrate Without Exposing the Database
Partners get a clean REST surface and a revocable key - never your Postgres credentials, never raw XML-RPC against every model.
Least-Privilege by Design
Each key carries only the scopes it needs - read students but not fees, attendance but not academics - and every key is scoped to one school's company.
Event-Driven, Not Poll-Driven
Signed webhooks push enrolment, attendance and fee events to partner systems in real time, so you stop hammering the API with polls.
Fully Auditable
Every request - success, auth failure, scope denial or rate-limit hit - lands in an access log with key, endpoint, status, IP and latency.
Feature Highlights
Scoped API Keys
Generate sk_... keys with independent read scopes. The plaintext is shown once; only a salted SHA-256 hash is stored.
Per-Key Rate Limiting
A configurable requests-per-minute budget protects the instance; over-budget calls get a clean 429.
Versioned REST Endpoints
/api/v1/students, /students/, /attendance, /fees/invoices and /ping - predictable JSON envelopes.
Signed Outbound Webhooks
Subscribe to enrolment, attendance and fee events; each POST carries an X-SchoolOS-Signature HMAC header.
Immutable Access Log
Every call recorded with outcome, status, IP and latency - with a retention sweep to keep the table lean.
Multi-School Isolation
Queries run scoped to the key's company, so a key for one branch can never read another branch's records.
Endpoints & Tooling
GET /api/v1/ping- health & key identity checkGET /api/v1/students- paginated active-student rosterGET /api/v1/students/- single student detailGET /api/v1/attendance- recent attendance recordsGET /api/v1/fees/invoices- fee invoices with balances- Authenticate with the
X-API-Keyheader - no session cookies - Stable JSON envelope:
{"data": ...}or{"error": {code, message}}
Integrates with SchoolOS
This application is part of the SchoolOS suite and requires the main SchoolOS application (the unified data model, roles and portals). SchoolOS - REST API Gateway reads the same student / staff / academic / fee records used across every SchoolOS module, so an integration built once stays correct as the suite grows - and role-based access plus multi-school scoping are enforced consistently. Get the complete suite here:
Technical Quality
- Role-based and record-rule access control
- Multi-school and multi-curriculum ready
- Hashed, revocable, expiring API credentials
- Per-key rate limiting and full audit log
- HMAC-signed outbound webhooks
- Clean, extendable Odoo 19 architecture
- Runs on Odoo Community and Enterprise
- Deploy on Odoo.sh or on-premises
Customisation, Implementation & Mobile Apps
Customisation & Implementation: Binary Bridge Technology Services provides full customisation, configuration, data migration, training and on-the-ground implementation for SchoolOS. To scope your rollout, contact us at odoo@bbtech.ae or WhatsApp +971 56 128 6321.
Native iOS & Android mobile apps for all SchoolOS portals are available as a separate add-on (not included in the suite license). See the main SchoolOS listing for mobile-app pricing and options.
Built for GCC & international schools
SchoolOS is a unified school-management platform for the Gulf and international K-12 market - multi-curriculum (CBSE | IB | British | American | MOE | Cambridge), multi-school and multi-currency, with Arabic / RTL interfaces and an optional Hijri calendar. It runs entirely on Odoo 19 Community or Enterprise, on Odoo.sh or on-premises, with full Odoo accounting built in. Built and tested for GCC schools - and fully usable by any school worldwide.
Why SchoolOS vs the alternatives
How an integrated, GCC-ready Odoo suite compares with a generic SIS or a stack of spreadsheets and point tools.
| Capability | SchoolOS | Generic SIS | Spreadsheets / point tools |
|---|---|---|---|
| Single unified student / staff record across every module | ✓ | - | - |
| Multi-school & multi-company scoping with record rules | ✓ | partial | - |
| Role-based Student / Parent / Teacher / Admin portals | ✓ | partial | - |
| Fees & accounting that post to Odoo | ✓ | - | - |
| Arabic / RTL interface + Hijri calendar option | ✓ | - | - |
| Runs on Odoo 19 Community & Enterprise | ✓ | partial | n/a |
| Multi-curriculum (CBSE / IB / British / American / MOE) | ✓ | partial | - |
| One vendor, one stack, audited ISO processes | ✓ | - | - |
Frequently asked questions
About Binary Bridge
Binary Bridge Technology Services is an Odoo implementation and product partner based in the United Arab Emirates. We have delivered solutions across 36+ industries, implemented for 256+ clients, and bring 10+ years of Odoo ERP implementation and development experience. Every engagement follows audited quality and data-security processes.
Ready to connect SchoolOS to your stack?
Talk to Binary Bridge for integration design, implementation and on-the-ground rollout support - or get the Complete SchoolOS Bundle now.
Screenshots
Also included in this app
More capabilities that ship in this module - all part of the one SchoolOS licence.
- Per-key usage telemetry - request count, last-used and last-IP
- Named read scopes per data domain (students, attendance, fees)
This app is sold only as part of the complete SchoolOS bundle
Every SchoolOS module is built on the shared SchoolOS core and works together as one system - installed on its own, a single app has limited use. To get the full, integrated value, purchase the complete SchoolOS suite (one unified licence, USD 12,500) rather than this module alone.
Get the Complete SchoolOS Suite →Odoo Proprietary License v1.0 This software and associated files (the "Software") may only be used (executed, modified, executed after modifications) if you have purchased a valid license from the authors, typically via Odoo Apps, or if you have received a written agreement from the authors of the Software (see the COPYRIGHT file). You may develop Odoo modules that use the Software as a library (typically by depending on it, importing it and using its resources), but without copying any source code or material from the Software. You may distribute those modules under the license of your choice, provided that this license is compatible with the terms of the Odoo Proprietary License (For example: LGPL, MIT, or proprietary licenses similar to this one). It is forbidden to publish, distribute, sublicense, or sell copies of the Software or modified copies of the Software. The above copyright notice and this permission notice must be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please log in to comment on this module