Skip to main content

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

GoalStart hereWhy
Decide between browser, token, and server architecturesIntegration ArchitectureCompares auth and deployment models before you write code
Build a browser UI or internal toolBrowser UI PlaybookCovers session mode, controlled browser token mode, list queries, CRUD, and UI-safe patterns
Build a backend, worker, or scheduled integrationServer-Side IntegrationsCovers token storage, refresh, low-level requests, and sync jobs
Reuse working implementation patternsSample ApplicationsShows reusable frontend patterns without framework lock-in
Need the full generated surfaceJavaScript ClientFull API coverage and low-level request escape hatch
  • Prefer @zeyos/client for JavaScript applications.
  • Use filters in client code unless you have a reason to stay with raw API filter.
  • Include visibility: 0 for normal business views.
  • Use explicit body objects for update operations that also include path parameters such as ID.
  • Treat extdata and expand as separate concepts:
    • extdata exposes custom fields
    • expand inlines JSON or binary columns

Next Steps