From a page to a Tabs app#
SDK 0.2.0 is available on npm:
npm install @tabschat/miniapp-sdk
The browser bootstrap connects your app to the hosted simulator. The hosted script also works with existing Bridge V1 apps and needs no npm update.
- Clone
https://github.com/tabschat-at/miniapp-sdk.gitand runnpm run devfrom its root. Open the preview link for Hello Tabs, then its permissions-denied variant. - Copy
examples/hello-tabs,examples/sharedandsrcinto your publisher's static site, retaining this layout while trying the example. Replace its app ID, name and entrypoint inmanifest.jsonwith your domain and page URL. - Add only the permissions you use. Implement an ordinary page with buttons,
window.hostcalls and your ownfetchrequests. Handle denial gracefully. - Host the page at a stable HTTPS URL with valid TLS and no entrypoint redirect.
For another API or asset origin, declare the exact HTTPS origin in
networkAccess; the API must also permit your publisher origin through CORS. - Use the package builder to generate the manifest and
Lexicons. Add its
tabs-manifestandtabs-packagelinks to your HTML head and deploy those files together. Runnpm run validate -- /path/to/app-package, then enter the deployed URL in the submission tool. Review the discovered package and permissions before submitting. Public package files must include no secrets; contact details are private to Tabs reviewers. - After approval, open the listing inside Tabs. Accept or decline the first-visit sheet and check native behavior on a real device.
The preview server is HTTP on loopback for desktop development only. An installed Tabs host accepts reviewed HTTPS entrypoints; it does not load the localhost mock. There is currently no user-accessible sideload URL flow or automatic registration endpoint. Host approval is required even for a webapp asking for no capabilities.
With a bundler, install the SDK package instead of copying src:
npm install @tabschat/miniapp-sdk
import "@tabschat/miniapp-sdk/bootstrap";
import { getHost, type HostBridgeV1 } from "@tabschat/miniapp-sdk";
const host: HostBridgeV1 = getHost(window);
TypeScript definitions are bundled; a plain browser can use the ES module
directly. The full developer kit and examples are available from the GitHub
repository and release download. Deploy
the runtime and your page assets, not dev/, tests, server code or mock injection.
The recipe example's /api/recipes must be supplied by your own backend/reverse
proxy in production. Its browser preview feed is a separate fixture and does not
reflect mock publications. A usable verified backend is included in
own-appview.
If you install the package in your app, validate its manifest with
npx tabs-miniapp-validate /path/to/app-package. Full preview examples are in the
GitHub kit; they are not bundled into the runtime npm package.
Using an AI coding agent? Start with the complete compatibility prompt, then check its implementation against the contracts above.
For hosted browser testing, load the browser bootstrap in your regular deployment and allow the developer site to frame your app. Simulated users are the default; approved apps can opt into a real Tabs account for backend sign-in and record operations.