(PowerBuilder) ShippingEasy.com Calculate Signature for API Authentication

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
integer li_Success
oleobject loo_SbStringToSign
string ls_HttpVerb
string ls_UriPath
string ls_QueryParamsStr
oleobject loo_Json
oleobject loo_Dt
integer li_BLocalTime
string ls_UnixEpochTimestamp
string ls_Your_api_key
integer li_NumReplaced
string ls_Your_api_secret
oleobject loo_Crypt
string ls_Api_signature
oleobject loo_Http
oleobject loo_QueryParams
oleobject loo_Resp

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

loo_SbStringToSign = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbStringToSign.ConnectToNewObject("Chilkat.StringBuilder")
if li_rc < 0 then
    destroy loo_SbStringToSign
    MessageBox("Error","Connecting to COM object failed")
    return
end if

ls_HttpVerb = "POST"
ls_UriPath = "/partners/api/accounts"
ls_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"
//   }
// }

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

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

loo_Json.EmitCompact = 0
Write-Debug loo_Json.Emit()

// First, let's get the current date/time in the Unix Epoch Timestamp format (which is just an integer)
loo_Dt = create oleobject
// Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
li_rc = loo_Dt.ConnectToNewObject("Chilkat.CkDateTime")

loo_Dt.SetFromCurrentSystemTime()
// Get the UTC time.
li_BLocalTime = 0
ls_UnixEpochTimestamp = loo_Dt.GetAsUnixTimeStr(li_BLocalTime)

// Build the string to sign:
loo_SbStringToSign.Append(ls_HttpVerb)
loo_SbStringToSign.Append("&")
loo_SbStringToSign.Append(ls_UriPath)
loo_SbStringToSign.Append("&")
loo_SbStringToSign.Append(ls_QueryParamsStr)
loo_SbStringToSign.Append("&")
// Make sure to send the JSON body of a request in compact form..
loo_Json.EmitCompact = 1
loo_SbStringToSign.Append(loo_Json.Emit())

// Use your API key here:
ls_Your_api_key = "f9a7c8ebdfd34beaf260d9b0296c7059"

li_NumReplaced = loo_SbStringToSign.Replace("YOUR_API_KEY",ls_Your_api_key)
li_NumReplaced = loo_SbStringToSign.Replace("UNIX_EPOCH_TIMESTAMP",ls_UnixEpochTimestamp)

// Do the HMAC-SHA256 with your API secret:
ls_Your_api_secret = "ea210785fa4656af03c2e4ffcc2e7b5fc19f1fba577d137905cc97e74e1df53d"
loo_Crypt = create oleobject
// Use "Chilkat_9_5_0.Crypt2" for versions of Chilkat < 10.0.0
li_rc = loo_Crypt.ConnectToNewObject("Chilkat.Crypt2")

loo_Crypt.MacAlgorithm = "hmac"
loo_Crypt.EncodingMode = "hexlower"
loo_Crypt.SetMacKeyString(ls_Your_api_secret)
loo_Crypt.HashAlgorithm = "sha256"

ls_Api_signature = loo_Crypt.MacStringENC(loo_SbStringToSign.GetAsString())
Write-Debug "api_signature: " + ls_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...
loo_SbStringToSign.Clear()
loo_SbStringToSign.Append("GET")
loo_SbStringToSign.Append("&")
loo_SbStringToSign.Append("/app.shippingeasy.com/api/orders")
loo_SbStringToSign.Append("&")
loo_SbStringToSign.Append(ls_QueryParamsStr)
loo_SbStringToSign.Append("&")
// There is no body for a GET request.

ls_Api_signature = loo_Crypt.MacStringENC(loo_SbStringToSign.GetAsString())

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("api_signature",ls_Api_signature)
loo_QueryParams.UpdateString("api_timestamp",ls_UnixEpochTimestamp)
loo_QueryParams.UpdateString("api_key",ls_Your_api_key)

loo_Resp = loo_Http.QuickRequestParams("GET","https://app.shippingeasy.com/api/orders",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_SbStringToSign
    destroy loo_Json
    destroy loo_Dt
    destroy loo_Crypt
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug "response status code = " + string(loo_Resp.StatusCode)
Write-Debug "response body:"
Write-Debug loo_Resp.BodyStr

destroy loo_Resp


destroy loo_SbStringToSign
destroy loo_Json
destroy loo_Dt
destroy loo_Crypt
destroy loo_Http
destroy loo_QueryParams