Dart Requires Chilkat v11.0.0+

ShippingEasy.com Calculate Signature for API Authentication

See more HTTP Misc Examples

Demonstrates how to calculate the shippingeasy.com API signature for authenticating requests. 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.

  // First, concatenate these into a plaintext string using the following order:
  // 
  //     Capitilized method of the request. E.g. "POST"
  //     The URI path
  //     The query parameters sorted alphabetically and concatenated together into a URL friendly format: param1=ABC&param2=XYZ
  //     The request body as a string if one exists
  //     All parts are then concatenated together with an ampersand. The result resembles something like this:
  // 
  // "POST&/partners/api/accounts&api_key=f9a7c8ebdfd34beaf260d9b0296c7059&api_timestamp=1401803554&{ ... request body ... }"

  final sbStringToSign = CkStringBuilder();

  final httpVerb = 'POST';
  final uriPath = '/partners/api/accounts';
  final queryParamsStr = 'api_key=YOUR_API_KEY&api_timestamp=UNIX_EPOCH_TIMESTAMP';

  // Build the following JSON that will be the body of the request:

  // {
  //   "account": {
  //     "first_name": "Coralie",
  //     "last_name": "Waelchi",
  //     "company_name": "Hegmann, Cremin and Bradtke",
  //     "email": "se_greg_6d477b1e59e8ff24abadfb59d3a2de3e@shippingeasy.com",
  //     "phone_number": "1-381-014-3358",
  //     "address": "2476 Flo Inlet",
  //     "address2": "",
  //     "state": "SC",
  //     "city": "North Dennis",
  //     "postal_code": "29805",
  //     "country": "USA",
  //     "password": "abc123",
  //     "subscription_plan_code": "starter"
  //   }
  // }

  final json = CkJsonObject();
  json.updateString('account.first_name', 'Coralie');
  json.updateString('account.last_name', 'Waelchi');
  json.updateString('account.company_name', 'Hegmann, Cremin and Bradtke');
  json.updateString('account.email', 'se_greg_6d477b1e59e8ff24abadfb59d3a2de3e@shippingeasy.com');
  json.updateString('account.phone_number', '1-381-014-3358');
  json.updateString('account.address', '2476 Flo Inlet');
  json.updateString('account.address2', '');
  json.updateString('account.state', 'SC');
  json.updateString('account.city', 'North Dennis');
  json.updateString('account.postal_code', '29805');
  json.updateString('account.country', 'USA');
  json.updateString('account.password', 'abc123');
  json.updateString('account.subscription_plan_code', 'starter');

  json.emitCompact = false;
  print(json.emit());

  // First, let's get the current date/time in the Unix Epoch Timestamp format (which is just an integer)
  final dt = CkDateTime();
  dt.setFromCurrentSystemTime();
  // Get the UTC time.
  final bLocalTime = false;
  final unixEpochTimestamp = dt.getAsUnixTimeStr(bLocalTime);

  // Build the string to sign:
  sbStringToSign.append(httpVerb);
  sbStringToSign.append('&');
  sbStringToSign.append(uriPath);
  sbStringToSign.append('&');
  sbStringToSign.append(queryParamsStr);
  sbStringToSign.append('&');
  // Make sure to send the JSON body of a request in compact form..
  json.emitCompact = true;
  sbStringToSign.append(json.emit());

  // Use your API key here:
  final yourApiKey = 'f9a7c8ebdfd34beaf260d9b0296c7059';

  var numReplaced = sbStringToSign.replace('YOUR_API_KEY', yourApiKey);
  numReplaced = sbStringToSign.replace('UNIX_EPOCH_TIMESTAMP', unixEpochTimestamp);

  // Do the HMAC-SHA256 with your API secret:
  final yourApiSecret = 'ea210785fa4656af03c2e4ffcc2e7b5fc19f1fba577d137905cc97e74e1df53d';
  final crypt = CkCrypt2();
  crypt.macAlgorithm = 'hmac';
  crypt.encodingMode = 'hexlower';
  crypt.setMacKeyString(yourApiSecret);
  crypt.hashAlgorithm = 'sha256';

  var apiSignature = crypt.macStringENC(sbStringToSign.getAsString());
  print('api_signature: $apiSignature');

  // --------------------------------------------------------------------
  // Here's an example showing how to use the signature in a request:

  // Build a new string-to-sign and create a new api_signature for the actual request we'll be sending...
  sbStringToSign.clear();
  sbStringToSign.append('GET');
  sbStringToSign.append('&');
  sbStringToSign.append('/app.shippingeasy.com/api/orders');
  sbStringToSign.append('&');
  sbStringToSign.append(queryParamsStr);
  sbStringToSign.append('&');
  // There is no body for a GET request.

  apiSignature = crypt.macStringENC(sbStringToSign.getAsString());

  final http = CkHttp();
  final queryParams = CkJsonObject();

  queryParams.updateString('api_signature', apiSignature);
  queryParams.updateString('api_timestamp', unixEpochTimestamp);
  queryParams.updateString('api_key', yourApiKey);

  final resp = CkHttpResponse();
  try {
    http.httpParams('GET', 'https://app.shippingeasy.com/api/orders', queryParams, resp);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('response status code = ${resp.statusCode}');
  print('response body:');
  print(resp.bodyStr);
}