The Partner Portal, Step by Step
Everything around your app that is not code lives in the SitePack Partner Portal: your organisation and team, the app itself, its Marketplace listing, its prices, its OAuth credentials and the review. This page walks through it in the order you will need it.
The code of your app (app.json, templates, scripts, translations) is shipped with the SitePack CLI. The portal and the CLI work on the same app, identified by its uuid.
Step 1: Create a partner account
- Go to admin.sitepack.eu/partners and choose Become a SitePack partner.
- Fill in your name, email address and a password of at least 8 characters, and click Create account.
You are signed in straight away and land on the partner overview.
Step 2: Register your organisation
Apps belong to an organisation, not to a person, so a colleague can take over when you are away.
- On the partner overview, click Create organisation.
- Fill in your company name and address, accept the partner terms and click Register Organisation.
You become the Owner of the organisation. The sidebar now shows Home, Apps, Themes, Sites, Team and Settings.
Step 3: Invite your team (optional)
Under Team, click Invite member, enter their name and email address and pick a role:
| Role | Can use |
|---|---|
| Owner | Everything, including team, settings and removing apps |
| App developer | Home and Apps |
| Theme developer | Home and Themes |
| Content manager | Home and Sites |
Someone without a SitePack account gets one, with an invitation by email. Owners and App developers receive the emails about your app reviews.
Step 4: Create the app
Go to Apps and click Create app. You can start in two ways:
- In the portal: enter an Application Name and click Generate App. SitePack creates the app with a starter
app.json. Download it withsitepack app:checkout. - With the CLI: run
sitepack app:initin the folder where you want the app. It registers the app in your organisation and sets up the starter files locally. See CLI commands.
Already have the files, for example from a colleague? Run sitepack app:link path/to/app to register them as a new app in your organisation.
SitePack always assigns the app's uuid. It is written into your app.json; do not change it, because it is how sitepack app:publish knows which app to update.
A new app starts as Private, at version 1.
Step 5: Publish your code
Build your app locally (see Your First App) and upload it:
sitepack app:publish
Each publish creates a new version number and makes it the app's current version. Until the first publish, the app page shows Upload required.
Step 6: Fill in the app details
Open the app from Apps. At the top, the App Overview shows the icon, the name, the current version and the description from your app.json. Click Edit App to change:
- App Name
- App Icon (WEBP, PNG or JPG, 2 MB max). Needed for the Marketplace and the review.
- Visibility: Private or Public. Public is only possible once the app has an icon and its
app.jsonhas a description of at least 10 characters.
The Distribution card in the sidebar shows the status and the app's Install link, for you to share. Whoever opens it always gets a consent screen first, showing your app, their site and the price. For a private app the link carries a token, so only people you give it to can install the app. (Installs from the Marketplace itself work as described in Publishing & Monetization.)
Step 7: Decide whether you need OAuth
The OAuth & install card is off by default, and for a storefront app it stays off. Only switch it on when your app calls the SitePack API from your own server. See API Integrations for when you need it.
When you click Enable OAuth:
- Enter your Redirect URI: the page on your server where SitePack sends the merchant back after they approve. Save it.
- SitePack now shows your credentials:
- Client ID and Client secret, for the token exchange.
- Webhook signing secret, to verify webhooks and the OAuth callback.
- Install link, a ready-made OAuth link to the consent screen for your app, with your scopes filled in. Put it behind a "Connect SitePack" button in your own product.
- You can Rotate client secret and Rotate signing secret at any time, for example when a secret has leaked. Update your server right after rotating.
The OAuth settings are locked while your app is in review.
Step 8: Try the app on your own site
Install the app on a site you manage and check it on the storefront:
- In the Distribution card on your app page, copy the Install link.
- Open it while you are signed in to SitePack, with the site you want to test on as your current site.
- Approve the consent screen. It shows your app, the site and the price.
A storefront app then opens its settings page in the admin. An app with OAuth sends you on to your redirect URI with an authorization code, like any merchant.
The link works for private apps too, so you can test before the review. While your app is private, the link carries a token: only people you give it to can install the app. Share it with a client to install a private app on their site.
After installing, the app appears in the site's admin under Apps, with your settings page. Every sitepack app:publish goes live on the sites where the app is installed straight away, so you see your change after a reload.
Step 9: Write the Marketplace listing
In the sidebar of the app page, click Manage Marketplace Listing. You write the listing in English only. When you save, SitePack translates it into Dutch, German and Spanish within a few minutes. See Marketplace listing.
You fill in:
| Field | Tips |
|---|---|
| Tagline | One line, up to 150 characters |
| Short Description | Shown on the app tile |
| Long Description | What the app does and for whom |
| Key Features (USPs) | Up to 5 short points |
| Tags | Comma separated, used for search and the category |
| Website | Your product or support page |
| Screenshots | 4 images; PNG, JPG, GIF, WebP or SVG, 2 MB each |
Click Save Listing per language.
Step 10: Set a price
Under Monetization, click Manage Plans and Add Plan. A plan has a name, a pricing type and up to 5 benefits:
- Free
- One-time fee
- Monthly subscription, with an optional yearly price
An app without a plan is free. SitePack bills the merchant for you; see Publishing & Monetization.
Step 11: Submit for review
Set the visibility to Public. The app page now shows the Review checklist, which SitePack runs against your current version:
| Check | Blocks the submit |
|---|---|
| Icon uploaded | Yes |
| English listing complete (tagline, both descriptions, tags, USPs) | Yes |
app.json has a name, a description of 10+ characters and a version | Yes |
Every template and script in app.json exists | Yes |
| Image settings point at an image inside the app | Yes |
| All 4 screenshots uploaded | No, warning |
| Every setting is used somewhere in your files | No, warning |
| Translatable settings are text fields | No, warning |
| No outside payment providers in your code | No, warning |
When nothing blocks, click Submit for Review. The Submission Progress bar moves to Submitted & in review and the listing is locked until the review is done. You and your App developers get an email when it is submitted and again with the result.
- Approved: the app is live and public in the Marketplace.
- Rejected: the review notes say what to change. Fix it and click Resubmit for Review, as often as you need.
The Submission History at the bottom of the app page keeps every round with its notes. Read the App Marketplace Policy before your first submission.
After you go live
- Updates: run
sitepack app:publish. The new version is live on every site that has the app installed, without a new review. Test first, see Step 8. - Numbers: once the app is installed somewhere, the app page shows installs, paying customers, MRR and ARR.
- Removing an app: under Danger Zone, click Remove App. A live app has to be set to Private first, so merchants are not surprised.