(PowerBuilder) 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

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_Json
string ls_Url
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Token
string ls_ApiAlias

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("includes.sales_channel_context[0]","token")

// Put the access token in the sw-access-key request header.
loo_Http.SetRequestHeader("sw-access-key","<sales-channel-api-access-key>")

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


ls_Url = "https://my-shopware-6-shop.de/store-api/v3/context"
loo_Resp = loo_Http.PText("GET",ls_Url,loo_Json.Emit(),"utf-8","application/json",0,0)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    return
end if

loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

// If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_Resp

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

ls_Token = loo_JResp.StringOf("token")
ls_ApiAlias = loo_JResp.StringOf("apiAlias")


destroy loo_Http
destroy loo_Json
destroy loo_SbResponseBody
destroy loo_JResp