DataFlex

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

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoRest
    Boolean iBTls
    Integer iPort
    Boolean iBAutoReconnect
    Variant vAuthAws
    Handle hoAuthAws
    String sPath
    Handle hoSbPath
    String sResponseJson
    String sTemp1
    Boolean bTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatRest)) To hoRest
    If (Not(IsComObjectCreated(hoRest))) Begin
        Send CreateComObject of hoRest
    End

    // Connect to the REST server.
    Move True To iBTls
    Move 443 To iPort
    Move True To iBAutoReconnect
    Get ComConnect Of hoRest "sellingpartnerapi-eu.amazon.com" iPort iBTls iBAutoReconnect To iSuccess

    Get ComClearAllQueryParams Of hoRest To iSuccess
    Get ComAddQueryParam Of hoRest "marketplaceids" "XYZABC123" To iSuccess
    Get ComAddQueryParam Of hoRest "includedData" "offers" To iSuccess

    Get ComAddHeader Of hoRest "x-amz-access-token" "YOUR_ACCESS_TOKEN" To iSuccess

    Get Create (RefClass(cComChilkatAuthAws)) To hoAuthAws
    If (Not(IsComObjectCreated(hoAuthAws))) Begin
        Send CreateComObject of hoAuthAws
    End
    Set ComAccessKey Of hoAuthAws To "YOUR_AWS_APP_ID"
    Set ComSecretKey Of hoAuthAws To "YOUR_AWS_APP_SECRET_KEY"
    Set ComRegion Of hoAuthAws To "eu-west-1"
    Set ComServiceName Of hoAuthAws To "execute-api"
    Get pvComObject of hoAuthAws to vAuthAws
    Get ComSetAuthAws Of hoRest vAuthAws To iSuccess

    // The path that is passed to FullRequestNobBody

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

    // 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:
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbPath
    If (Not(IsComObjectCreated(hoSbPath))) Begin
        Send CreateComObject of hoSbPath
    End
    Get ComAppend Of hoSbPath "100x100_28g_LANCETS(BOXED)" To iSuccess
    // URL encode the contents of the sbPath.
    Get ComEncode Of hoSbPath "url" "utf-8" To iSuccess
    // Prepend the remaining which does not need to be URL encoded.
    Get ComPrepend Of hoSbPath "/listings/2022-07-01/items/ABCDEFGHIJ/" To iSuccess

    Get ComGetAsString Of hoSbPath To sTemp1
    Showln "URL encoded path: " sTemp1

    Get ComGetAsString Of hoSbPath To sTemp1
    Get ComFullRequestNoBody Of hoRest "GET" sTemp1 To sResponseJson
    Get ComLastMethodSuccess Of hoRest To bTemp1
    If (bTemp1 <> True) Begin
        Get ComLastErrorText Of hoRest To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Showln sResponseJson
    Showln "----"


End_Procedure