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 <C_CkRestW.h>
#include <C_CkAuthAwsW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkRestW rest;
    BOOL bTls;
    int port;
    BOOL bAutoReconnect;
    HCkAuthAwsW authAws;
    const wchar_t *path;
    HCkStringBuilderW sbPath;
    const wchar_t *responseJson;

    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

    rest = CkRestW_Create();

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

    CkRestW_ClearAllQueryParams(rest);
    CkRestW_AddQueryParam(rest,L"marketplaceids",L"XYZABC123");
    CkRestW_AddQueryParam(rest,L"includedData",L"offers");

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

    authAws = CkAuthAwsW_Create();
    CkAuthAwsW_putAccessKey(authAws,L"YOUR_AWS_APP_ID");
    CkAuthAwsW_putSecretKey(authAws,L"YOUR_AWS_APP_SECRET_KEY");
    CkAuthAwsW_putRegion(authAws,L"eu-west-1");
    CkAuthAwsW_putServiceName(authAws,L"execute-api");
    CkRestW_SetAuthAws(rest,authAws);

    // The path that is passed to FullRequestNobBody

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

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

    responseJson = CkRestW_fullRequestNoBody(rest,L"GET",CkStringBuilderW_getAsString(sbPath));
    if (CkRestW_getLastMethodSuccess(rest) != TRUE) {
        wprintf(L"%s\n",CkRestW_lastErrorText(rest));
        CkRestW_Dispose(rest);
        CkAuthAwsW_Dispose(authAws);
        CkStringBuilderW_Dispose(sbPath);
        return;
    }

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


    CkRestW_Dispose(rest);
    CkAuthAwsW_Dispose(authAws);
    CkStringBuilderW_Dispose(sbPath);

    }