Lua

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.. Lua

local chilkat = require("chilkat")

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

local rest = chilkat.Rest.new()

-- Connect to the REST server.
local bTls = true
local port = 443
local bAutoReconnect = true
local success = rest:connect("sellingpartnerapi-eu.amazon.com", port, bTls, bAutoReconnect)

rest:clear_all_query_params()
rest:add_query_param("marketplaceids", "XYZABC123")
rest:add_query_param("includedData", "offers")

rest:add_header("x-amz-access-token", "YOUR_ACCESS_TOKEN")

local authAws = chilkat.AuthAws.new()
authAws.access_key = "YOUR_AWS_APP_ID"
authAws.secret_key = "YOUR_AWS_APP_SECRET_KEY"
authAws.region = "eu-west-1"
authAws.service_name = "execute-api"
rest:set_auth_aws(authAws)

-- The path that is passed to FullRequestNobBody

-- Here's a sample path that is not yet URL encoded.
local 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:
local sbPath = chilkat.StringBuilder.new()
sbPath:append("100x100_28g_LANCETS(BOXED)")
-- URL encode the contents of the sbPath.
sbPath:encode("url", "utf-8")
-- Prepend the remaining which does not need to be URL encoded.
sbPath:prepend("/listings/2022-07-01/items/ABCDEFGHIJ/")

print("URL encoded path: " .. sbPath:get_as_string())

local responseJson = rest:full_request_no_body("GET", sbPath:get_as_string())
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

print(responseJson)
print("----")