Ruby

Create Restricted Data Token (RDT)

See more Amazon SP-API Examples

Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. Ruby

require 'chilkat'

success = false

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

authAws = Chilkat::CkAuthAws.new()
authAws.put_AccessKey("AWS_ACCESS_KEY")
authAws.put_SecretKey("AWS_SECRET_KEY")
authAws.put_ServiceName("execute-api")
# Use the region that is correct for your needs.
authAws.put_Region("eu-west-1")

rest = Chilkat::CkRest.new()
bTls = true
port = 443
bAutoReconnect = true
# The sandbox endpoint (sandbox.sellingpartnerapi-eu.amazon.com) fails.
# Use the production endpoint and see the note below.
success = rest.Connect("sellingpartnerapi-eu.amazon.com",port,bTls,bAutoReconnect)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

success = rest.SetAuthAws(authAws)

# Load the previously obtained LWA access token.
# See Fetch SP-API LWA Access Token
jsonToken = Chilkat::CkJsonObject.new()
success = jsonToken.LoadFile("qa_data/tokens/sp_api_lwa_token.json")
if (success == false)
    print "Failed to load LWA access token." + "\n";
    exit
end

# Add the x-amz-access-token request header.
lwa_token = jsonToken.stringOf("access_token")
rest.ClearAllHeaders()
rest.AddHeader("x-amz-access-token",lwa_token)

# We're going to send a POST with the following JSON body:

# {
#   "restrictedResources": [
#     {
#       "method": "GET",
#       "path": "/orders/v0/orders",
#       "dataElements": ["buyerInfo", "shippingAddress"]
#     }
#   ]
# }

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

json = Chilkat::CkJsonObject.new()
json.UpdateString("restrictedResources[0].method","GET")
json.UpdateString("restrictedResources[0].path","/orders/v0/orders")
json.UpdateString("restrictedResources[0].dataElements[0]","buyerInfo")
json.UpdateString("restrictedResources[0].dataElements[1]","shippingAddress")

sbRequest = Chilkat::CkStringBuilder.new()
json.EmitSb(sbRequest)

sbResponse = Chilkat::CkStringBuilder.new()
uri = "/tokens/2021-03-01/restrictedDataToken"
success = rest.FullRequestSb("POST",uri,sbRequest,sbResponse)
if (success == false)
    print rest.lastErrorText() + "\n";
    exit
end

# ------------------------------------------------------------------------------------
# Note: Using the sandbox endpoint, such as sandbox.sellingpartnerapi-eu.amazon.com
# results in a response status code of 400 with the following error:
# [{"code":"InvalidInput","message":"Could not match input arguments"}]
# Getting a restricted data token seems to only work with the production endpoint.
# ------------------------------------------------------------------------------------

# Examine the response status.
statusCode = rest.get_ResponseStatusCode()
if (statusCode != 200)
    print "Response status code: " + statusCode.to_s() + "\n";
    print "Response status text: " + rest.responseStatusText() + "\n";
    print "Response body: " + "\n";
    print sbResponse.getAsString() + "\n";
    print "Failed." + "\n";
    exit
end

print sbResponse.getAsString() + "\n";

# If successful, gets a JSON response such as the following:

# {
#   "expiresIn": 3600,
#   "restrictedDataToken": "Atz.sprdt|AYAB.....TQ="
# }

# Use this online tool to generate parsing code from sample JSON: 
# Generate Parsing Code from JSON

jsonResp = Chilkat::CkJsonObject.new()
jsonResp.LoadSb(sbResponse)

expiresIn = jsonResp.IntOf("expiresIn")
restrictedDataToken = jsonResp.stringOf("restrictedDataToken")

# Save the RDT for subsequent use..
success = jsonResp.WriteFile("qa_data/tokens/sp_api_rdt_token.json")

print "Success!" + "\n";