shopware / app-php-sdk

Shopware APP SDK Independent of Frameworks

Shopware APP SDK for PHP

This SDK is independent of any Framework. It uses PSR Request/Response/HttpClient to be usable cross framework.

Features

• Registration flow
• Lifecycle handling (app activated, deactivated, uninstalled)
• Convert actions (Webhook, ActionButton, Payment, ...) into structs
• Framework agnostic (PSR Request/Response/HttpClient/Repository)
• Events

Symfony Bundle

If you are using Symfony, you can use the Symfony Bundle to integrate the SDK. To get started with it, refer to the below documentation.

Documentation

• Getting Started
• Lifecycle
• Context
• Signing
• HTTP Client
• Events

Example

Checkout the example project for a simple working example.

app-php-sdk's Issues

PaymentResponse::authorized() not correctly transmitted

The payment state authorized apparently does not exist in Shopware core.

Error message:

Illegal transition "authorized" from state "ed6ef84314b14802bd57fcb48b3ad7e8". Possible transitions are: authorize, cancel, do_pay, fail, paid, paid_partially, pay, pay_partially, process_unconfirmed, remind

So I suggest changing the state name in PaymentResponse.php#L47 to authorize which results in the correct state transition.

Showpare Issuetracker: NEXT-26749

Add Events

Resolve request to Context objects

Map specific Requests from Shopware to Structs/DTO

• Webhook
• AppAction Button
• Iframe

Webhook

Example payload for a webhook request:

{
    "data": {
        "payload": {
            "changes": [
                "TestApp.config.email"
            ]
        },
        "event": "system_config.changed"
    },
    "source": {
        "url": "http://localhost:8000/",
        "eventId": "3e069abfb24f45a5a25e5c03c97ad47c",
        "appVersion": "1.0.0",
        "shopId": "ImbjsXWd9ZHbVDfr"
    },
    "timestamp": 1680530463
}

App Action

{
  "source": {
    "url": "http://localhost:8000/",
    "appVersion": "1.0.0",
    "shopId": "ImbjsXWd9ZHbVDfr"
  },
  "data": {
    "ids": [
      "3e069abfb24f45a5a25e5c03c97ad47c"
    ],
    "entity": "product",
    "action": "detail"
  }
}

Add HttpClient

Add uninstall to RegistrationService

Add Logger