Introduction

This page provides information about the configuration of the Shopware API.

API Integration

In order to map documents to Shopware you have to generate an API integration in the administration panel of Shopware (go to Settings -> Integrations -> Add Integration).

Afterwards you have to add that API integration to the configuration of the module.

You have to generate an integration with admin rights.

{
    "shopwareApi": {
        "host": "...",
        "accessKeyId": "...",
        "secretAccessKey": "..."
    }
}

Timeouts

Duration in seconds after a request to Shopware is cancelled. Defaults to 90.

{
    "shopwareApi": {
        "timeout": 90
    }
}

Log Request URLs

Determines whether the request URLs sent to Shopware are logged. Defaults to true.

{
    "shopwareApi": {
        "printRequests": true
    }
}

Log Exceptions

Determines whether the module collects information about failed API requests. You can find the collected information in vendor/synqup/shopware-6-admin-api-client/src/Logging/logs. You will find a file called api_request_exceptions_{flow_execution_id}.json.

This feature is being worked on and the presentation of the exceptions will be improved in the future.

{
    "shopwareApi": {
        "logExceptions": true
    }
}

Configuration

{
    "shopwareApi": {
        "host": "http://my-example-shop.io/",
        "accessKeyId": "...",
        "secretAccessKey": "...",
        "printRequests": true,
        "logExceptions": true,
        "timeout": 90
    }
}