Dart

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

import 'package:chilkat/chilkat.dart';

void main() {
  // 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

  final rest = CkRest();

  // Connect to the REST server.
  final bTls = true;
  final port = 443;
  final bAutoReconnect = true;
  rest.connect('sellingpartnerapi-eu.amazon.com', port, bTls, bAutoReconnect);

  rest.clearAllQueryParams();
  rest.addQueryParam('marketplaceids', 'XYZABC123');
  rest.addQueryParam('includedData', 'offers');

  rest.addHeader('x-amz-access-token', 'YOUR_ACCESS_TOKEN');

  final authAws = CkAuthAws();
  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.
  final 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:
  final sbPath = CkStringBuilder();
  sbPath.append('100x100_28g_LANCETS(BOXED)');
  // URL encode the contents of the sbPath.
  sbPath.encode('url', 'utf-8');
  // Prepend the remaining which does not need to be URL encoded.
  sbPath.prepend('/listings/2022-07-01/items/ABCDEFGHIJ/');

  print('URL encoded path: ${sbPath.getAsString()}');

  final String responseJson;
  try {
    responseJson = rest.fullRequestNoBody('GET', sbPath.getAsString());
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print(responseJson);
  print('----');
}