Getting Started with Apps

This guide will walk you through the initial steps of creating and developing your first SitePack App.

Prerequisites

Before you begin, ensure you have:

• A free partner account on SitePack.
• The SitePack CLI installed and authenticated.

1. Creating Your App

There are two primary ways to initiate a new SitePack App:

Option A: From the Partner Dashboard (Recommended)

1. Log in to the SitePack Partner Dashboard.
2. Navigate to the Apps section and click Create New App.
3. Fill in the basic details for your app.
4. Once created, use the SitePack CLI to download the app files to your local machine:

   sitepack app:checkout

   Follow the prompts to select your app.

Option B: From the CLI

If you prefer to start locally, you can use the CLI:

1. Run the following command:

   sitepack app:init

2. Follow the prompts to name your app and configure its initial settings. This will create the necessary file structure locally.

2. Developing Your App

Once your app is initialized, you can start building its functionality. The core of your app is the app.json manifest file, which defines your app's permissions, webhooks, and UI extensions.

Letting merchants install your app

Before a merchant can grant your app access, set up its OAuth credentials in the Partner Dashboard under your app's OAuth & install section:

1. Set the redirect URI - where SitePack sends the merchant (with the authorization code) after they approve. This provisions your app's client_id and client_secret.
2. Copy the install link. SitePack builds a ready-to-use link that opens the consent screen with your client_id, your declared scopes and your redirect URI already filled in. Drop it into your own product (for example a "Connect SitePack" button in a POS system). Generate a fresh, random state value per install and put it in the link.
3. Public apps additionally appear in the SitePack Marketplace, where a merchant can install them directly - the Marketplace's Install button sends them to the same consent screen for their active site.

See Authentication (OAuth) for the full authorization-code exchange.

Next Steps

Now that you've initialized your app, dive deeper into the technical details:

• App Manifest (app.json): Define your app's structure and permissions.
• Authentication (OAuth): Securely interact with SitePack stores.
• Scopes & Permissions: Request the right data access.
• Webhooks: Respond to real-time events.
• Editor Elements: Build custom blocks for the visual editor.
• Admin UI Integration: Add settings and widgets to the Admin dashboard.
• Publishing & Monetization: Share and sell your app.

3. Publishing Your App

When you are ready to share your app or test it in a live environment, use the CLI to publish it:

sitepack app:publish

This command synchronizes your local files with the SitePack servers and creates a new version of your app.

Visibility and Monetization

An app can have different visibility settings:

• Private Apps: These are restricted to specific stores or your own organization. They are ideal for custom integrations.
• Public Apps: These are available on the SitePack Marketplace for all merchants to discover and install.

tip

An app is only sellable when it is set to Public. Refer to the Publishing & Monetization section for more details on pricing models.