Unicode C++

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.. Unicode C++

#include <CkRestW.h>
#include <CkAuthAwsW.h>
#include <CkStringBuilderW.h>

void ChilkatSample(void)
    {
    bool success = 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

    CkRestW rest;

    // Connect to the REST server.
    bool bTls = true;
    int port = 443;
    bool bAutoReconnect = true;
    success = rest.Connect(L"sellingpartnerapi-eu.amazon.com",port,bTls,bAutoReconnect);

    rest.ClearAllQueryParams();
    rest.AddQueryParam(L"marketplaceids",L"XYZABC123");
    rest.AddQueryParam(L"includedData",L"offers");

    rest.AddHeader(L"x-amz-access-token",L"YOUR_ACCESS_TOKEN");

    CkAuthAwsW authAws;
    authAws.put_AccessKey(L"YOUR_AWS_APP_ID");
    authAws.put_SecretKey(L"YOUR_AWS_APP_SECRET_KEY");
    authAws.put_Region(L"eu-west-1");
    authAws.put_ServiceName(L"execute-api");
    rest.SetAuthAws(authAws);

    // The path that is passed to FullRequestNobBody

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

    wprintf(L"URL encoded path: %s\n",sbPath.getAsString());

    const wchar_t *responseJson = rest.fullRequestNoBody(L"GET",sbPath.getAsString());
    if (rest.get_LastMethodSuccess() != true) {
        wprintf(L"%s\n",rest.lastErrorText());
        return;
    }

    wprintf(L"%s\n",responseJson);
    wprintf(L"----\n");
    }