SQL Server

Shopware 6 - Store API Authentication

See more Shopware 6 Examples

Each sales channel has an accessKey, which can be generated in the administration or over the admin api. This accessKey is used for the authentication by providing it in the sw-access-key

You can test the authentication by sending a request to the store-api/v1/context endpoint

Note: This example only serves to test authentication. It returns a "token". This may lead you to believe that the returned token is what is required to authentication with subsequent Store API requests. This is NOT the case. The Store API requests simply authentication with the sw-access-key, just as this request does. The returned "token" is a context token which can be used to switch the different values of your current "session" like active language, currency or shipping location.

Furthermore, Store API requests don't actually require an OAuth2 access token. The OAuth2 access token is needed for API requests (i.e. "/api/v3/..." as opposed to "/store-api/v3/...")

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Sends the following request

    -- GET http://shopware.development/store-api/v3/context
    -- --header sw-access-key SWSCYKQZODFVTVHJEHI0RFN0RG
    -- 
    -- {
    --     "includes": {
    --         "sales_channel_context": ["token"]
    --     }
    -- }

    -- Use this online tool to generate code from sample JSON:
    -- Generate Code to Create JSON

    DECLARE @json int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'includes.sales_channel_context[0]', 'token'

    -- Put the access token in the sw-access-key request header.
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'sw-access-key', '<sales-channel-api-access-key>'

    -- The sales channel API access key is obtained from your Shopware 6 admin portal:
    -- (image:https://example-code.com/images/shopware_sales_channel.jpg/endImage)

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://my-shopware-6-shop.de/store-api/v3/context'
    DECLARE @resp int
    EXEC @hr = sp_OACreate 'Chilkat.HttpResponse', @resp OUT

    EXEC sp_OAMethod @http, 'HttpJson', @success OUT, 'GET', @url, @json, 'application/json', @resp
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @resp
        RETURN
      END

    DECLARE @sbResponseBody int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
    DECLARE @jResp int
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT

    EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
    EXEC sp_OASetProperty @jResp, 'EmitCompact', 0


    PRINT 'Response Body:'
    EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    DECLARE @respStatusCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT

    PRINT 'Response Status Code = ' + @respStatusCode
    IF @respStatusCode >= 400
      BEGIN

        PRINT 'Response Header:'
        EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @resp
        EXEC @hr = sp_OADestroy @sbResponseBody
        EXEC @hr = sp_OADestroy @jResp
        RETURN
      END

    -- Sample JSON response:
    -- (Sample code for parsing the JSON response is shown below)

    -- {
    --     "token": "OCqj5ZEnpS0W9KgseOofPLqGArVjd5CE",
    --     "apiAlias": "sales_channel_context"
    --     ...
    -- }

    -- Sample code for parsing the JSON response...
    -- Use the following online tool to generate parsing code from sample JSON:
    -- Generate Parsing Code from JSON

    DECLARE @token nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @token OUT, 'token'
    DECLARE @apiAlias nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @apiAlias OUT, 'apiAlias'

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @resp
    EXEC @hr = sp_OADestroy @sbResponseBody
    EXEC @hr = sp_OADestroy @jResp


END
GO