(Objective-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..

Chilkat Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoRest.h>
#import <CkoAuthAws.h>
#import <NSString.h>
#import <CkoStringBuilder.h>

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

CkoRest *rest = [[CkoRest alloc] init];

// Connect to the REST server.
BOOL bTls = YES;
int port = 443;
BOOL bAutoReconnect = YES;
BOOL success = [rest Connect: @"sellingpartnerapi-eu.amazon.com" port: [NSNumber numberWithInt: port] tls: bTls autoReconnect: bAutoReconnect];

[rest ClearAllQueryParams];
[rest AddQueryParam: @"marketplaceids" value: @"XYZABC123"];
[rest AddQueryParam: @"includedData" value: @"offers"];

[rest AddHeader: @"x-amz-access-token" value: @"YOUR_ACCESS_TOKEN"];

CkoAuthAws *authAws = [[CkoAuthAws alloc] init];
authAws.AccessKey = @"YOUR_AWS_APP_ID";
authAws.SecretKey = @"YOUR_AWS_APP_SECRET_KEY";
authAws.Region = @"eu-west-1";
authAws.ServiceName = @"execute-api";
[rest SetAuthAws: authAws];

// The path that is passed to FullRequestNobBody

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

NSLog(@"%@%@",@"URL encoded path: ",[sbPath GetAsString]);

NSString *responseJson = [rest FullRequestNoBody: @"GET" uriPath: [sbPath GetAsString]];
if (rest.LastMethodSuccess != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

NSLog(@"%@",responseJson);
NSLog(@"%@",@"----");