Zig

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

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

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

    const rest = try chilkat.Rest.init();
    defer rest.deinit();

    // Connect to the REST server.
    const b_tls = true;
    const port = 443;
    const b_auto_reconnect = true;
    try rest.connect("sellingpartnerapi-eu.amazon.com", port, b_tls, b_auto_reconnect);

    rest.clearAllQueryParams() catch {};
    rest.addQueryParam("marketplaceids", "XYZABC123") catch {};
    rest.addQueryParam("includedData", "offers") catch {};

    rest.addHeader("x-amz-access-token", "YOUR_ACCESS_TOKEN") catch {};

    const auth_aws = try chilkat.AuthAws.init();
    defer auth_aws.deinit();
    auth_aws.setAccessKey("YOUR_AWS_APP_ID");
    auth_aws.setSecretKey("YOUR_AWS_APP_SECRET_KEY");
    auth_aws.setRegion("eu-west-1");
    auth_aws.setServiceName("execute-api");
    rest.setAuthAws(auth_aws) catch {};

    // The path that is passed to FullRequestNobBody

    // Here's a sample path that is not yet URL encoded.

    // 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:
    const sb_path = try chilkat.StringBuilder.init();
    defer sb_path.deinit();
    sb_path.append("100x100_28g_LANCETS(BOXED)") catch {};
    // URL encode the contents of the sbPath.
    sb_path.encode("url", "utf-8") catch {};
    // Prepend the remaining which does not need to be URL encoded.
    sb_path.prepend("/listings/2022-07-01/items/ABCDEFGHIJ/") catch {};

    std.debug.print("URL encoded path: {s}\n", .{try sb_path.getAsString(alloc)});

    const response_json = rest.fullRequestNoBody(alloc, "GET", try sb_path.getAsString(alloc)) catch {
        std.debug.print("{s}\n", .{try rest.getLastErrorText(alloc)});
        return;
    };

    std.debug.print("{s}\n", .{response_json});
    std.debug.print("----\n", .{});
}