Appearance
API Details
Complete reference for Kooboo server-side k.* APIs. The English structure mirrors the Chinese /api/ section and keeps the same module layout for easier lookup.
Getting Started
| Doc | Description |
|---|---|
| API Getting Started | KScript basics and the shape of the global k object |
| Authentication and Authorization | Login, sessions, cookies, and access control |
KScript APIs
| Module | Doc | Description |
|---|---|---|
k.account | account/ | Platform login, current user, organization, and OAuth |
k.api | api/ | API route helpers |
k.cache | cache/ | Site-level in-memory cache |
k.commerce | commerce/ | Commerce APIs including product, cart, and order pages |
k.content | content/ | Content types and content items |
k.cookie | cookie/ | Cookies |
k.DB | database/, indexed-db/, key-value/, sqlite/ | Database access, IndexedDB tables, key-value storage, and SQLite |
k.file | file/ | Files in the site directory |
k.google | google/ | PageSpeed/Lighthouse and Firebase |
k.label | label/ | Multilingual k.t and k.label |
k.logger | logger/ | Code logs |
k.mail | mail/ | Sending mail, IMAP, SES, and parsing |
k.media | media/ | Media library files and folders |
k.module | module/ | Script modules, config, tasks, and packaging |
k.openApi | openapi/ | External OpenAPI definitions, auth, and calls |
k.net | net/ | HTTP, WebSocket, DNS, IP, Ping, SSH, SFTP, and Telnet |
k.page | page/ | Current page title and meta |
k.paramConfig | param-config/ | Structured JSON parameter config |
k.payment | payment/ | Payment integrations |
k.request | request/ | HTTP request data |
k.response | response/ | HTTP response handling |
k.security | security/ | Encryption and hashing |
k.session | session/ | Session state |
k.site | site/ | Pages, layouts, views, scripts, styles, codes, and menus |
k.state | state/ | Per-request view state |
k.utils | utils/ | Utility modules |
| SPA multilingual | spa-multilingual/ | /_spa/lang/{lang} dictionaries |
k.site Sub-Resources
| Member | Doc |
|---|---|
k.site.pages | page.md |
k.site.layouts | layout.md |
k.site.views | view.md |
k.site.scripts | js.md |
k.site.styles | css.md |
k.site.codes | code.md |
k.site.menus | menu.md |
k.site.runJob | job.md |
k.file Subpages
Subpages: folder, resumable, data structures
Related Sections
| Scenario | Next doc |
|---|---|
| You need to prepare content models or site settings first | Admin CMS |
| You need Page / Layout / View rendering rules first | Template Engine |