(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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

json = Chilkat::CkJsonObject.new()
json.UpdateString("includes.sales_channel_context[0]","token")

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

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


url = "https://my-shopware-6-shop.de/store-api/v3/context"
# resp is a CkHttpResponse
resp = http.PText("GET",url,json.emit(),"utf-8","application/json",false,false)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

# If we get a 401 response, it may be that our access token expired and we need to fetch a new one.
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
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

token = jResp.stringOf("token")
apiAlias = jResp.stringOf("apiAlias")