Unicode C++

ShippingEasy.com Calculate Signature for API Authentication

See more HTTP Misc Examples

Demonstrates how to calculate the shippingeasy.com API signature for authenticating requests. Unicode C++

#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>
#include <CkDateTimeW.h>
#include <CkCrypt2W.h>
#include <CkHttpW.h>
#include <CkHttpResponseW.h>

void ChilkatSample(void)
    {
    bool success = false;

    // 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 ... }"

    CkStringBuilderW sbStringToSign;

    const wchar_t *httpVerb = L"POST";
    const wchar_t *uriPath = L"/partners/api/accounts";
    const wchar_t *queryParamsStr = L"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"
    //   }
    // }

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

    json.put_EmitCompact(false);
    wprintf(L"%s\n",json.emit());

    // First, let's get the current date/time in the Unix Epoch Timestamp format (which is just an integer)
    CkDateTimeW dt;
    dt.SetFromCurrentSystemTime();
    // Get the UTC time.
    bool bLocalTime = false;
    const wchar_t *unixEpochTimestamp = dt.getAsUnixTimeStr(bLocalTime);

    // Build the string to sign:
    sbStringToSign.Append(httpVerb);
    sbStringToSign.Append(L"&");
    sbStringToSign.Append(uriPath);
    sbStringToSign.Append(L"&");
    sbStringToSign.Append(queryParamsStr);
    sbStringToSign.Append(L"&");
    // Make sure to send the JSON body of a request in compact form..
    json.put_EmitCompact(true);
    sbStringToSign.Append(json.emit());

    // Use your API key here:
    const wchar_t *your_api_key = L"f9a7c8ebdfd34beaf260d9b0296c7059";

    int numReplaced = sbStringToSign.Replace(L"YOUR_API_KEY",your_api_key);
    numReplaced = sbStringToSign.Replace(L"UNIX_EPOCH_TIMESTAMP",unixEpochTimestamp);

    // Do the HMAC-SHA256 with your API secret:
    const wchar_t *your_api_secret = L"ea210785fa4656af03c2e4ffcc2e7b5fc19f1fba577d137905cc97e74e1df53d";
    CkCrypt2W crypt;
    crypt.put_MacAlgorithm(L"hmac");
    crypt.put_EncodingMode(L"hexlower");
    crypt.SetMacKeyString(your_api_secret);
    crypt.put_HashAlgorithm(L"sha256");

    const wchar_t *api_signature = crypt.macStringENC(sbStringToSign.getAsString());
    wprintf(L"api_signature: %s\n",api_signature);

    // --------------------------------------------------------------------
    // 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(L"GET");
    sbStringToSign.Append(L"&");
    sbStringToSign.Append(L"/app.shippingeasy.com/api/orders");
    sbStringToSign.Append(L"&");
    sbStringToSign.Append(queryParamsStr);
    sbStringToSign.Append(L"&");
    // There is no body for a GET request.

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

    CkHttpW http;
    CkJsonObjectW queryParams;

    queryParams.UpdateString(L"api_signature",api_signature);
    queryParams.UpdateString(L"api_timestamp",unixEpochTimestamp);
    queryParams.UpdateString(L"api_key",your_api_key);

    CkHttpResponseW resp;
    success = http.HttpParams(L"GET",L"https://app.shippingeasy.com/api/orders",queryParams,resp);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    wprintf(L"response status code = %d\n",resp.get_StatusCode());
    wprintf(L"response body:\n");
    wprintf(L"%s\n",resp.bodyStr());
    }