Xbase++ 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. Xbase++

LOCAL nSuccess
LOCAL oSbStringToSign
LOCAL cHttpVerb
LOCAL cUriPath
LOCAL cQueryParamsStr
LOCAL oJson
LOCAL oDt
LOCAL nBLocalTime
LOCAL cUnixEpochTimestamp
LOCAL cYour_api_key
LOCAL nNumReplaced
LOCAL cYour_api_secret
LOCAL oCrypt
LOCAL cApi_signature
LOCAL oHttp
LOCAL oQueryParams
LOCAL oResp

nSuccess := 0

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

oSbStringToSign := CreateObject("Chilkat.StringBuilder")

cHttpVerb := "POST"
cUriPath := "/partners/api/accounts"
cQueryParamsStr := "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"
//    }
//  }

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

oJson:EmitCompact := 0
? oJson:Emit()

//  First, let's get the current date/time in the Unix Epoch Timestamp format (which is just an integer)
oDt := CreateObject("Chilkat.CkDateTime")
oDt:SetFromCurrentSystemTime()
//  Get the UTC time.
nBLocalTime := 0
cUnixEpochTimestamp := oDt:GetAsUnixTimeStr(nBLocalTime)

//  Build the string to sign:
oSbStringToSign:Append(cHttpVerb)
oSbStringToSign:Append("&")
oSbStringToSign:Append(cUriPath)
oSbStringToSign:Append("&")
oSbStringToSign:Append(cQueryParamsStr)
oSbStringToSign:Append("&")
//  Make sure to send the JSON body of a request in compact form..
oJson:EmitCompact := 1
oSbStringToSign:Append(oJson:Emit())

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

nNumReplaced := oSbStringToSign:Replace("YOUR_API_KEY", cYour_api_key)
nNumReplaced := oSbStringToSign:Replace("UNIX_EPOCH_TIMESTAMP", cUnixEpochTimestamp)

//  Do the HMAC-SHA256 with your API secret:
cYour_api_secret := "ea210785fa4656af03c2e4ffcc2e7b5fc19f1fba577d137905cc97e74e1df53d"
oCrypt := CreateObject("Chilkat.Crypt2")
oCrypt:MacAlgorithm := "hmac"
oCrypt:EncodingMode := "hexlower"
oCrypt:SetMacKeyString(cYour_api_secret)
oCrypt:HashAlgorithm := "sha256"

cApi_signature := oCrypt:MacStringENC(oSbStringToSign:GetAsString())
? "api_signature: " + cApi_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...
oSbStringToSign:Clear()
oSbStringToSign:Append("GET")
oSbStringToSign:Append("&")
oSbStringToSign:Append("/app.shippingeasy.com/api/orders")
oSbStringToSign:Append("&")
oSbStringToSign:Append(cQueryParamsStr)
oSbStringToSign:Append("&")
//  There is no body for a GET request.

cApi_signature := oCrypt:MacStringENC(oSbStringToSign:GetAsString())

oHttp := CreateObject("Chilkat.Http")
oQueryParams := CreateObject("Chilkat.JsonObject")

oQueryParams:UpdateString("api_signature", cApi_signature)
oQueryParams:UpdateString("api_timestamp", cUnixEpochTimestamp)
oQueryParams:UpdateString("api_key", cYour_api_key)

oResp := CreateObject("Chilkat.HttpResponse")
nSuccess := oHttp:HttpParams("GET", "https://app.shippingeasy.com/api/orders", oQueryParams, oResp)
IF (nSuccess == 0)
    ? oHttp:LastErrorText
    oSbStringToSign:destroy()
    oJson:destroy()
    oDt:destroy()
    oCrypt:destroy()
    oHttp:destroy()
    oQueryParams:destroy()
    oResp:destroy()
    RETURN
ENDIF

? "response status code = " + Str(oResp:StatusCode)
? "response body:"
? oResp:BodyStr

oSbStringToSign:destroy()
oJson:destroy()
oDt:destroy()
oCrypt:destroy()
oHttp:destroy()
oQueryParams:destroy()
oResp:destroy()