Rust

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

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

let rest = chilkat::Rest::new();

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

let _ = rest.clear_all_query_params();
let _ = rest.add_query_param("marketplaceids", "XYZABC123");
let _ = rest.add_query_param("includedData", "offers");

let _ = rest.add_header("x-amz-access-token", "YOUR_ACCESS_TOKEN");

let auth_aws = chilkat::AuthAws::new();
auth_aws.set_access_key("YOUR_AWS_APP_ID");
auth_aws.set_secret_key("YOUR_AWS_APP_SECRET_KEY");
auth_aws.set_region("eu-west-1");
auth_aws.set_service_name("execute-api");
let _ = rest.set_auth_aws(&auth_aws);

// The path that is passed to FullRequestNobBody

// Here's a sample path that is not yet URL encoded.
let path = "/listings/2022-07-01/items/ABCDEFGHIJ/100x100_28g_LANCETS(BOXED)".to_string();

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

println!("URL encoded path: {}", sb_path.get_as_string().unwrap_or_default());

let Ok(response_json) = rest.full_request_no_body("GET", &sb_path.get_as_string().unwrap_or_default()) else {
    println!("{}", rest.last_error_text());
    return;
};

println!("{}", response_json);
println!("----");