Application Developers
This path is for developers building external applications that use ZeyOS as the central source of business data and business logic.
For v1, the scope is explicitly external integrations:
- browser UIs
- server-side services
- automation backends
- connected internal tools
These docs do not cover authoring native ZeyOS platform artifacts.
Choose Your Starting Point
| Goal | Start here | Why |
|---|---|---|
| Decide between browser, token, and server architectures | Integration Architecture | Compares auth and deployment models before you write code |
| Build a browser UI or internal tool | Browser UI Playbook | Covers session mode, controlled browser token mode, list queries, CRUD, and UI-safe patterns |
| Build a backend, worker, or scheduled integration | Server-Side Integrations | Covers token storage, refresh, low-level requests, and sync jobs |
| Reuse working implementation patterns | Sample Applications | Shows reusable frontend patterns without framework lock-in |
| Need the full generated surface | JavaScript Client | Full API coverage and low-level request escape hatch |
Recommended Defaults
- Prefer
@zeyos/clientfor JavaScript applications. - Use
filtersin client code unless you have a reason to stay with raw APIfilter. - Include
visibility: 0for normal business views. - Use explicit
bodyobjects for update operations that also include path parameters such asID. - Treat
extdataandexpandas separate concepts:extdataexposes custom fieldsexpandinlines JSON or binary columns
Next Steps
- Read Integration Architecture
- Pick either the Browser UI Playbook or Server-Side Integrations
- Use the API Reference and JavaScript Client docs as the detailed reference layers