Tcl

REST URL Encode Path Parts and Query Params

See more REST Examples

When passing a path to a Chilkat REST function, the path parts and query params should be URL encoded. This example explains.. Tcl

load ./chilkat.dll

set success 0

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

# This example demonstrates how to URL encode the path passed to a REST function.
# It is demonstrated with an Amazon SP API GET request to get details about a listings item for a selling partner.
# See https://developer-docs.amazon.com/sp-api/docs/listings-items-api-v2021-08-01-reference#getlistingsitem

set rest [new_CkRest]

# Connect to the REST server.
set bTls 1
set port 443
set bAutoReconnect 1
set success [CkRest_Connect $rest "sellingpartnerapi-eu.amazon.com" $port $bTls $bAutoReconnect]

CkRest_ClearAllQueryParams $rest
CkRest_AddQueryParam $rest "marketplaceids" "XYZABC123"
CkRest_AddQueryParam $rest "includedData" "offers"

CkRest_AddHeader $rest "x-amz-access-token" "YOUR_ACCESS_TOKEN"

set authAws [new_CkAuthAws]

CkAuthAws_put_AccessKey $authAws "YOUR_AWS_APP_ID"
CkAuthAws_put_SecretKey $authAws "YOUR_AWS_APP_SECRET_KEY"
CkAuthAws_put_Region $authAws "eu-west-1"
CkAuthAws_put_ServiceName $authAws "execute-api"
CkRest_SetAuthAws $rest $authAws

# The path that is passed to FullRequestNobBody

# Here's a sample path that is not yet URL encoded.
set path "/listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS(BOXED)"

# The path passed to FullRequestNoBody needs to have the parts URL-encoded.
# The "/" chars are not URL encoded, but the individual path parts should be URL encoded.
# For example:  /listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS%28BOXED%29

# In this case, we'll prepare the path like this:
set sbPath [new_CkStringBuilder]

CkStringBuilder_Append $sbPath "100x100_28g_LANCETS(BOXED)"
# URL encode the contents of the sbPath.
CkStringBuilder_Encode $sbPath "url" "utf-8"
# Prepend the remaining which does not need to be URL encoded.
CkStringBuilder_Prepend $sbPath "/listings/2022-07-01/items/ABCDEFGHIJ/"

puts "URL encoded path: [CkStringBuilder_getAsString $sbPath]"

set responseJson [CkRest_fullRequestNoBody $rest "GET" [CkStringBuilder_getAsString $sbPath]]
if {[CkRest_get_LastMethodSuccess $rest] != 1} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkRest $rest
    delete_CkAuthAws $authAws
    delete_CkStringBuilder $sbPath
    exit
}

puts "$responseJson"
puts "----"

delete_CkRest $rest
delete_CkAuthAws $authAws
delete_CkStringBuilder $sbPath