Lua 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. Lua

local chilkat = require("chilkat")

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

local sbStringToSign = chilkat.StringBuilder.new()

local httpVerb = "POST"
local uriPath = "/partners/api/accounts"
local 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"
--   }
-- }

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

json.emit_compact = false
print(json:emit())

-- First, let's get the current date/time in the Unix Epoch Timestamp format (which is just an integer)
local dt = chilkat.DateTime.new()
dt:set_from_current_system_time()
-- Get the UTC time.
local bLocalTime = false
local unixEpochTimestamp = dt:get_as_unix_time_str(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.emit_compact = true
sbStringToSign:append(json:emit())

-- Use your API key here:
local your_api_key = "f9a7c8ebdfd34beaf260d9b0296c7059"

local numReplaced = sbStringToSign:replace("YOUR_API_KEY", your_api_key)
numReplaced = sbStringToSign:replace("UNIX_EPOCH_TIMESTAMP", unixEpochTimestamp)

-- Do the HMAC-SHA256 with your API secret:
local your_api_secret = "ea210785fa4656af03c2e4ffcc2e7b5fc19f1fba577d137905cc97e74e1df53d"
local crypt = chilkat.Crypt2.new()
crypt.mac_algorithm = "hmac"
crypt.encoding_mode = "hexlower"
crypt:set_mac_key_string(your_api_secret)
crypt.hash_algorithm = "sha256"

local api_signature = crypt:mac_string_enc(sbStringToSign:get_as_string())
print("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()
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.

api_signature = crypt:mac_string_enc(sbStringToSign:get_as_string())

local http = chilkat.Http.new()
local queryParams = chilkat.JsonObject.new()

queryParams:update_string("api_signature", api_signature)
queryParams:update_string("api_timestamp", unixEpochTimestamp)
queryParams:update_string("api_key", your_api_key)

local resp = chilkat.HttpResponse.new()
local success = http:http_params("GET", "https://app.shippingeasy.com/api/orders", queryParams, resp)
if not success then
    print(http.last_error_text)
    return
end

print("response status code = " .. resp.status_code)
print("response body:")
print(resp.body_str)