Dart

REST OAuth1 with Params

See more REST Examples

Demonstrates how to use OAuth 1.0a "one legged" authentication with Woo Commerce, with URLs that use query parameters. For example: /orders?status=processing Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates how to do OAuth1 authentication with query parameters (for a Wordpress site using Woo Commerce).

  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  // Prepare an OAuth 1.0 object for use with the Chilkat REST API.
  final oauth1 = CkOAuth1();
  oauth1.consumerKey = 'WOO_COMMERCE_CONSUMER_KEY';
  oauth1.consumerSecret = 'WOO_COMMERCE_CONSUMER_SECRET';

  // The signature method can be HMAC-SHA1 or HMAC-SHA256
  oauth1.signatureMethod = 'HMAC-SHA256';

  // The OauthUrl property will need to be updated each time a request is sent.
  // The domain here must match the domain passed to the Connect method (below).
  // The domain must be exact.  For example, "www.your-wordpress-site.com" vs. "your-wordpress-site.com".
  // One might work while the other does not..
  oauth1.oauthUrl = 'http://your-wordpress-site.com/wc-api/v3/orders';

  // We need to tell OAuth1 about our extra query parameters so they can be used
  // in generating the OAuth1 signature.
  // In this example, we want to add the param "status=processing"
  oauth1.addParam('status', 'processing');

  // The OAuthMethod property will be set automatically when the REST request is sent.
  // Setting it here is not actually necessary.
  oauth1.oauthMethod = 'GET';

  // Generate an initial nonce so that Chilkat knows the desired size of the nonce.
  oauth1.genNonce(32);

  final rest = CkRest();

  // Tell the REST object to use the OAuth1 object for authentication.
  // Also, indicate that the OAuth authentication parameters should be query parameters
  // and not located within the Authorization header.
  final bUseQueryParams = true;
  rest.setAuthOAuth1(oauth1, bUseQueryParams);

  // Make the initial connection (without sending a request yet) to the WooCommerce endpoint at your Wordpress blog.
  final bTls = false;
  final port = 80;
  final bAutoReconnect = true;
  try {
    rest.connect('your-wordpress-site.com', port, bTls, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Send a GET request to list orders.

  // The extra query params must be added here.
  // (Whatever params are added here should've also been added to the OAuth1 object.)
  rest.addQueryParam('status', 'processing');

  // When the request is sent, the OAuth1 object's Timestamp and Nonce properties are automatically
  // regenerated.  Also, the OAuth1 object's OauthMethod property is automatically set to the HTTP method
  // used for the request (in this case it is "GET").
  final String responseJson;
  try {
    responseJson = rest.fullRequestNoBody('GET', '/wc-api/v3/orders');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // When successful, the response status code will equal 200.
  if (rest.responseStatusCode != 200) {
    // Examine the request/response to see what happened.
    print('response status code = ${rest.responseStatusCode}');
    print('response status text = ${rest.responseStatusText}');
    print('response header: ${rest.responseHeader}');
    print('response body (if any): $responseJson');
    print('---');
    print('LastRequestStartLine: ${rest.lastRequestStartLine}');
    print('LastRequestHeader: ${rest.lastRequestHeader}');
    return;
  }

  print(responseJson);
  print('Success.');
}