Introduction to SitePack Apps
A SitePack app adds something to a merchant's website or webshop: a chat button, a tracking tag, a review widget, or a full sync with an ERP, a POS or an accounting package. Merchants find apps in the SitePack Marketplace and switch them on for their site.
You build and manage your apps in the SitePack Partner Portal, and you ship the app's files with the SitePack CLI. Partner accounts are free. All prices and payouts are in euros.
Two kinds of apps
Most apps fall into one of two groups. Knowing which one you are building saves you a lot of work.
1. Storefront apps (no OAuth)
The app lives entirely inside SitePack. You write a small Twig template and, if needed, a script. SitePack renders it on every page of the merchant's site and hands it the values the merchant filled in on your app's settings page.
- Example: our own WhatsApp button. The merchant enters their number, picks a corner and a colour, and the button appears on every page.
- You need: an
app.json, a template, and a settings schema. No server, no database, no OAuth. - Merchants install it with one click from the Marketplace. There is no consent screen there, because the app gets no access to their data. From an install link you share, they approve a short consent screen first.
This is the right choice for chat widgets, banners, popups, tag managers, pixels, review badges and anything else that only shows or loads something on the storefront.
2. API integrations (with OAuth)
The app runs on your own servers and talks to SitePack through the REST API: reading orders, syncing products or stock, pushing leads into a CRM. The merchant grants your app access on a consent screen, and you receive an access token for their site.
- Example: a POS or ERP connector that keeps stock and orders in sync.
- You need: everything from a storefront app (if you want settings or storefront output), plus an OAuth redirect URI, the scopes you use, and a backend that stores tokens.
- Merchants install it through the OAuth consent screen, where they see exactly which data you can read or change.
Only add OAuth when you really call the API. A storefront app that asks for API access shows the merchant permissions it never uses, and scopes you do not use are a reason to reject an app in review.
| Storefront app | API integration | |
|---|---|---|
| Hosting | Nothing to host, SitePack serves your files | Your own server |
| Merchant settings | SitePack settings page (recommended) | SitePack settings page, or your own page in an iframe |
| Data access | Only what the storefront shows | REST API, limited to the scopes the merchant grants |
| Real-time events | Browser events on the storefront | Browser events and signed webhooks to your server |
| Install | One click in the Marketplace, or a consent screen from your install link | OAuth consent screen, from the Marketplace or your install link |
Use SitePack settings
Whatever you build, let SitePack render your settings page. You describe the fields in app.json and SitePack turns them into a form in the merchant's admin, in the merchant's language, with colour pickers, dropdowns and a media picker built in. The merchant never leaves SitePack, and you never build or host a settings screen.
The values reach your storefront templates directly, and an API integration can read them through the public API. See App Settings.
What you can use
- Storefront blocks and scripts: render Twig into fixed spots of every theme (
head,body_end, around the add-to-cart form, in the customer account) and load your own JavaScript. - Storefront events: page views, cart changes, orders and consent, ready to forward to an analytics or marketing tool.
- App settings: a settings form generated from your schema.
- Translations: your labels and your storefront text in Dutch, English, German, French and Spanish.
- REST API and webhooks: for API integrations. All endpoints live on
https://api.sitepack.eu.
Where to go next
- The Partner Portal, Step by Step: create your account, your organisation and your app.
- Your First App: a WhatsApp Button: build a complete storefront app in about half an hour.
- API Integrations: when your app needs access to the merchant's data.
- Example Integration: a complete, runnable API integration.
- Testing & Debugging: where to look when something does not show up.
- Publishing & Monetization: get your app into the Marketplace and set a price.