Getting Started

This example assumes you already have a running app backend.

The app server is written in TypeScript and is an open-source project accessible at app-sdk-js.

Installation

Install the App PHP SDK via NPM:

npm install --save @shopware-ag/app-sdk-server

After installation, you can use the SDK in your project. Setting up the registration endpoints in your app is a natural next step.

Registration process

To handle app registration, create an AppServer instance and expose two routes:

• /authorize starts the registration flow
• /authorize/callback handles the callback from Shopware

In the following example, AppServer is configured with your app name, app secret, and authorize callback URL. InMemoryShopRepository stores registered shops in memory, which is useful for local development and testing. For production, replace it with a persistent database-backed repository.

import { AppServer, InMemoryShopRepository } from '@shopware-ag/app-server-sdk'

const app = new AppServer({
  appName: 'MyApp',
  appSecret: 'my-secret',
  authorizeCallbackUrl: 'http://localhost:3000/authorize/callback',
}, new InMemoryShopRepository());

export default {
  async fetch(request) {
    const { pathname } = new URL(request.url);
    if (pathname === '/authorize') {
      return app.registration.authorize(request);
    } else if (pathname === '/authorize/callback') {
      return app.registration.authorizeCallback(request);
    }

    return new Response('Not found', { status: 404 });
  }
};

First we create an AppServer instance with the app name, app secret and the authorize callback URL. The InMemoryShopRepository is used to store the shops in memory. You can also use a custom repository to store the shops in a database.

With this code, you can register your app with our custom app backend.

Next, we will look into the lifecycle handling.