(Xojo Plugin) ShippingEasy.com Calculate Signature for API Authentication

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

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim success As Boolean
Dim sbStringToSign As New Chilkat.StringBuilder

Dim httpVerb As String
httpVerb = "POST"
Dim uriPath As String
uriPath = "/partners/api/accounts"
Dim queryParamsStr As String
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"
//   }
// }

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

json.EmitCompact = False
System.DebugLog(json.Emit())

// First, let's get the current date/time in the Unix Epoch Timestamp format (which is just an integer)
Dim dt As New Chilkat.CkDateTime
success = dt.SetFromCurrentSystemTime()
// Get the UTC time.
Dim bLocalTime As Boolean
bLocalTime = False
Dim unixEpochTimestamp As String
unixEpochTimestamp = dt.GetAsUnixTimeStr(bLocalTime)

// Build the string to sign:
success = sbStringToSign.Append(httpVerb)
success = sbStringToSign.Append("&")
success = sbStringToSign.Append(uriPath)
success = sbStringToSign.Append("&")
success = sbStringToSign.Append(queryParamsStr)
success = sbStringToSign.Append("&")
// Make sure to send the JSON body of a request in compact form..
json.EmitCompact = True
success = sbStringToSign.Append(json.Emit())

// Use your API key here:
Dim your_api_key As String
your_api_key = "f9a7c8ebdfd34beaf260d9b0296c7059"

Dim numReplaced As Int32
numReplaced = sbStringToSign.Replace("YOUR_API_KEY",your_api_key)
numReplaced = sbStringToSign.Replace("UNIX_EPOCH_TIMESTAMP",unixEpochTimestamp)

// Do the HMAC-SHA256 with your API secret:
Dim your_api_secret As String
your_api_secret = "ea210785fa4656af03c2e4ffcc2e7b5fc19f1fba577d137905cc97e74e1df53d"
Dim crypt As New Chilkat.Crypt2
crypt.MacAlgorithm = "hmac"
crypt.EncodingMode = "hexlower"
success = crypt.SetMacKeyString(your_api_secret)
crypt.HashAlgorithm = "sha256"

Dim api_signature As String
api_signature = crypt.MacStringENC(sbStringToSign.GetAsString())
System.DebugLog("api_signature: " + 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 
success = sbStringToSign.Append("GET")
success = sbStringToSign.Append("&")
success = sbStringToSign.Append("/app.shippingeasy.com/api/orders")
success = sbStringToSign.Append("&")
success = sbStringToSign.Append(queryParamsStr)
success = sbStringToSign.Append("&")
// There is no body for a GET request.

api_signature = crypt.MacStringENC(sbStringToSign.GetAsString())

Dim http As New Chilkat.Http
Dim queryParams As New Chilkat.JsonObject

success = queryParams.UpdateString("api_signature",api_signature)
success = queryParams.UpdateString("api_timestamp",unixEpochTimestamp)
success = queryParams.UpdateString("api_key",your_api_key)

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://app.shippingeasy.com/api/orders",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog("response status code = " + Str(resp.StatusCode))
System.DebugLog("response body:")
System.DebugLog(resp.BodyStr)