Swift

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

func chilkatTest() {
    var success: Bool = 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

    let rest = CkoRest()!

    // Connect to the REST server.
    var bTls: Bool = true
    var port: Int = 443
    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "sellingpartnerapi-eu.amazon.com", port: port, tls: bTls, autoReconnect: bAutoReconnect)

    rest.clearAllQueryParams()
    rest.addQueryParam(name: "marketplaceids", value: "XYZABC123")
    rest.addQueryParam(name: "includedData", value: "offers")

    rest.addHeader(name: "x-amz-access-token", value: "YOUR_ACCESS_TOKEN")

    let authAws = CkoAuthAws()!
    authAws.accessKey = "YOUR_AWS_APP_ID"
    authAws.secretKey = "YOUR_AWS_APP_SECRET_KEY"
    authAws.region = "eu-west-1"
    authAws.serviceName = "execute-api"
    rest.setAuthAws(authProvider: authAws)

    // The path that is passed to FullRequestNobBody

    // Here's a sample path that is not yet URL encoded.
    var path: String? = "/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:
    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "100x100_28g_LANCETS(BOXED)")
    // URL encode the contents of the sbPath.
    sbPath.encode(encoding: "url", charset: "utf-8")
    // Prepend the remaining which does not need to be URL encoded.
    sbPath.prepend(value: "/listings/2022-07-01/items/ABCDEFGHIJ/")

    print("URL encoded path: \(sbPath.getAsString()!)")

    var responseJson: String? = rest.fullRequestNoBody(httpVerb: "GET", uriPath: sbPath.getAsString())
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    print("\(responseJson!)")
    print("----")

}