(Tcl) 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.

For more information, see https://developer-docs.amazon.com/sp-api/docs/tokens-api-v2021-03-01-reference#post-tokens2021-03-01restricteddatatoken

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "AWS_ACCESS_KEY"
CkAuthAws_put_SecretKey $authAws "AWS_SECRET_KEY"
CkAuthAws_put_ServiceName $authAws "execute-api"
# Use the region that is correct for your needs.
CkAuthAws_put_Region $authAws "eu-west-1"

set rest [new_CkRest]

set bTls 1
set port 443
set bAutoReconnect 1
# The sandbox endpoint (sandbox.sellingpartnerapi-eu.amazon.com) fails.
# Use the production endpoint and see the note below.
set success [CkRest_Connect $rest "sellingpartnerapi-eu.amazon.com" $port $bTls $bAutoReconnect]
if {$success == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkAuthAws $authAws
    delete_CkRest $rest
    exit
}

set success [CkRest_SetAuthAws $rest $authAws]

# Load the previously obtained LWA access token.
# See Fetch SP-API LWA Access Token
set jsonToken [new_CkJsonObject]

set success [CkJsonObject_LoadFile $jsonToken "qa_data/tokens/sp_api_lwa_token.json"]
if {$success == 0} then {
    puts "Failed to load LWA access token."
    delete_CkAuthAws $authAws
    delete_CkRest $rest
    delete_CkJsonObject $jsonToken
    exit
}

# Add the x-amz-access-token request header.
set lwa_token [CkJsonObject_stringOf $jsonToken "access_token"]
CkRest_ClearAllHeaders $rest
CkRest_AddHeader $rest "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

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "restrictedResources[0].method" "GET"
CkJsonObject_UpdateString $json "restrictedResources[0].path" "/orders/v0/orders"
CkJsonObject_UpdateString $json "restrictedResources[0].dataElements[0]" "buyerInfo"
CkJsonObject_UpdateString $json "restrictedResources[0].dataElements[1]" "shippingAddress"

set sbRequest [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequest

set sbResponse [new_CkStringBuilder]

set uri "/tokens/2021-03-01/restrictedDataToken"
set success [CkRest_FullRequestSb $rest "POST" $uri $sbRequest $sbResponse]
if {$success == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkAuthAws $authAws
    delete_CkRest $rest
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequest
    delete_CkStringBuilder $sbResponse
    exit
}

# ------------------------------------------------------------------------------------
# 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.
set statusCode [CkRest_get_ResponseStatusCode $rest]
if {$statusCode != 200} then {
    puts "Response status code: $statusCode"
    puts "Response status text: [CkRest_responseStatusText $rest]"
    puts "Response body: "
    puts [CkStringBuilder_getAsString $sbResponse]
    puts "Failed."
    delete_CkAuthAws $authAws
    delete_CkRest $rest
    delete_CkJsonObject $jsonToken
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequest
    delete_CkStringBuilder $sbResponse
    exit
}

puts [CkStringBuilder_getAsString $sbResponse]

# 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

set jsonResp [new_CkJsonObject]

CkJsonObject_LoadSb $jsonResp $sbResponse

set expiresIn [CkJsonObject_IntOf $jsonResp "expiresIn"]
set restrictedDataToken [CkJsonObject_stringOf $jsonResp "restrictedDataToken"]

# Save the RDT for subsequent use..
set success [CkJsonObject_WriteFile $jsonResp "qa_data/tokens/sp_api_rdt_token.json"]

puts "Success!"

delete_CkAuthAws $authAws
delete_CkRest $rest
delete_CkJsonObject $jsonToken
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequest
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $jsonResp