Appearance
Developer guide
Pick the reading path that matches what you're doing. Each path lists the pages to read first, in order.
New to BMA
Start here whatever you build. Half an hour gives you the words and the shape of the system.
- How BMA is built: the API, the shell, modules, App Builder, the marketplace; how a request is handled; organizations and their two databases.
- API conventions: the JSON envelope, errors, paging, CSRF, rate limits.
- Sign-in, SSO and API keys: how people and systems get in.
- Developer glossary: the words the code uses.
Module developer
You add a feature to BMA as a module: API routes, screens, menus, permissions, settings and its own data.
- Modules: kinds, how a module plugs in, versions and channels.
- Tutorial: your first module
- module.json reference
- The back end: router, permissions and menus, data, migrations, hooks, settings.
- The front end and the host calls for tabs, badges and shortcuts.
- Sign, test, release and upgrade
- Worked example: SAWScore
- Notifications and messages
App Builder developer
Tables, pages, queries and workflows, made in the browser for one organization, with no code.
- App Builder, then the tutorial
- App Builder reference
- Tenant API: reach the app's data from outside with an API key.
Integrator and SSO
You connect another system to BMA, or sign people in from your own platform.
- Sign people in to BMA: Sign-in, SSO and API keys covers password, LDAP or Active Directory, Google, MFA, and what isn't supported (SAML, generic OpenID Connect).
- Call BMA from your system: the Tenant API, with an organization's API key.
- Sell a product that runs on your own servers (vendor): BMA calls your system to create, suspend and close accounts: Provisioning API for vendor-hosted products.
Run a marketplace inside your platform (host)
- 1Get your codes and secret from BMA staffMarketplace code, host code, SSO secret
- 2Embed the marketplaceAbout 30 min
- 3Sign your users in
- 4Sync customers
- 5Act on entitlements
- 6Test, then go live
Core developer
You work on BMA's own code: the API, the shell, the core modules, the tests and releases. That guide is for BMA's engineers and is part of the staff site: Core engineering, at /docs/internal/engineering/ when you are signed in as BMA staff. It covers the dev sandbox, the rules the repository enforces, adding routes, permissions, migrations, console commands and cron tasks, writing tests, bin/check, releases, and the internals of organizations, encryption and sign-in.
Read the New to BMA pages above first.
You tell people something from your code
Notifications under the bell and messages, from module code, cron tasks, jobs, console commands, App Builder workflows or a module screen: Notifications and messages.