(DataFlex) 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/...")

For more information, see https://docs.shopware.com/en/shopware-platform-dev-en/store-api-guide/authentication?category=shopware-platform-dev-en/store-api-guide

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Handle hoJson
    String sUrl
    Variant vResp
    Handle hoResp
    Variant vSbResponseBody
    Handle hoSbResponseBody
    Handle hoJResp
    Integer iRespStatusCode
    String sToken
    String sApiAlias
    String sTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "includes.sales_channel_context[0]" "token" To iSuccess

    // Put the access token in the sw-access-key request header.
    Send ComSetRequestHeader To hoHttp "sw-access-key" "<sales-channel-api-access-key>"

    // The sales channel API access key is obtained from your Shopware 6 admin portal:
    

    Move "https://my-shopware-6-shop.de/store-api/v3/context" To sUrl
    Get ComEmit Of hoJson To sTemp1
    Get ComPText Of hoHttp "GET" sUrl sTemp1 "utf-8" "application/json" False False To vResp
    If (IsComObject(vResp)) Begin
        Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
        Set pvComObject Of hoResp To vResp
    End
    Get ComLastMethodSuccess Of hoHttp To bTemp1
    If (bTemp1 = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
    If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
        Send CreateComObject of hoSbResponseBody
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
    Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
    If (Not(IsComObjectCreated(hoJResp))) Begin
        Send CreateComObject of hoJResp
    End
    Get pvComObject of hoSbResponseBody to vSbResponseBody
    Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
    Set ComEmitCompact Of hoJResp To False

    Showln "Response Body:"
    Get ComEmit Of hoJResp To sTemp1
    Showln sTemp1

    // If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
    Get ComStatusCode Of hoResp To iRespStatusCode
    Showln "Response Status Code = " iRespStatusCode
    If (iRespStatusCode >= 400) Begin
        Showln "Response Header:"
        Get ComHeader Of hoResp To sTemp1
        Showln sTemp1
        Showln "Failed."
        Send Destroy of hoResp
        Procedure_Return
    End

    Send Destroy of hoResp

    // 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

    Get ComStringOf Of hoJResp "token" To sToken
    Get ComStringOf Of hoJResp "apiAlias" To sApiAlias


End_Procedure