API Architecture¶
Dedicated API Architecture Section
The API documentation has been expanded into a dedicated, clean, high-density architectural documentation section.
Please visit API Architecture Index for complete specifications:
- 🏛️ API Architecture Overview: System flow, dual-layer design, and security sandbox model.
- ⚡ Public JavaScript API: In-vault plugin registry lookup,
requestAccess(), andAuthorizedAPImethod contracts. - 🌐 Local REST Server: HTTP daemon (
127.0.0.1:8540), CORS headers, Bearer token middleware, and REST schemas. - 🛡️ Scopes & Permissions: Capability matrix, token storage, and revocation mechanics.
- 🧩 Internal API Engine: Active view tracking, workspace leaves, and
EventCacheintegration. - 📘 Recipes & Blueprints: Production code blueprints for plugins, DataviewJS, Templater, and Python.
Quick Component Summary¶
| Component | Responsibility | Must Not Own | Deep Dive |
|---|---|---|---|
PublicAPI |
Bouncer surface on app.plugins.plugins['full-calendar'].api. Handles token verification, PAT resolution, and plugin access request modals. |
Direct event state or provider I/O. | Public JS API Spec |
LocalServer |
Localhost HTTP server (127.0.0.1:${port}) running in Node.js. Translates incoming REST API requests (Bearer Token) into programmatically executed operations. |
UI presentation or file writing policies. | REST Server Spec |
InternalAPI |
Executes raw actions (querying, opening views, modifying events) using PluginState. |
Third-party validation logic or CLI exposure. | Internal API Engine |
PluginState |
Runtime singleton holding references to settings, cache, registry, and system capabilities. | Alternative sources of state. | Core Systems Spec |
EventCache |
Canonical cached event state and database mutations. | UI decisions or CLI protocol formatting. | EventCache Contract |
ProviderRegistry |
Network/Local calendar source route management and synchronization. | Client filtering engines. | Provider Architecture |