AutoIt

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

Local $bSuccess = False

; 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

$oRest = ObjCreate("Chilkat.Rest")

; Connect to the REST server.
Local $bTls = True
Local $iPort = 443
Local $bAutoReconnect = True
$bSuccess = $oRest.Connect("sellingpartnerapi-eu.amazon.com",$iPort,$bTls,$bAutoReconnect)

$oRest.ClearAllQueryParams()
$oRest.AddQueryParam("marketplaceids","XYZABC123")
$oRest.AddQueryParam("includedData","offers")

$oRest.AddHeader("x-amz-access-token","YOUR_ACCESS_TOKEN")

$oAuthAws = ObjCreate("Chilkat.AuthAws")
$oAuthAws.AccessKey = "YOUR_AWS_APP_ID"
$oAuthAws.SecretKey = "YOUR_AWS_APP_SECRET_KEY"
$oAuthAws.Region = "eu-west-1"
$oAuthAws.ServiceName = "execute-api"
$oRest.SetAuthAws($oAuthAws)

; The path that is passed to FullRequestNobBody

; Here's a sample path that is not yet URL encoded.
Local $sPath = "/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:
$oSbPath = ObjCreate("Chilkat.StringBuilder")
$oSbPath.Append("100x100_28g_LANCETS(BOXED)")
; URL encode the contents of the sbPath.
$oSbPath.Encode("url","utf-8")
; Prepend the remaining which does not need to be URL encoded.
$oSbPath.Prepend("/listings/2022-07-01/items/ABCDEFGHIJ/")

ConsoleWrite("URL encoded path: " & $oSbPath.GetAsString() & @CRLF)

Local $sResponseJson = $oRest.FullRequestNoBody("GET",$oSbPath.GetAsString())
If ($oRest.LastMethodSuccess <> True) Then
    ConsoleWrite($oRest.LastErrorText & @CRLF)
    Exit
EndIf

ConsoleWrite($sResponseJson & @CRLF)
ConsoleWrite("----" & @CRLF)