Tcl

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. Tcl

load ./chilkat.dll

set success 0

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Implements the following CURL command:

# curl https://api.goshippo.com/addresses/ \
#     -H "Authorization: ShippoToken <API_TOKEN>" \
#     -d name="Shawn Ippotle" \
#     -d company="Shippo" \
#     -d street1="Kortrijksesteenweg 1005" \
#     -d city="Gent" \
#     -d zip=9000 \
#     -d country="BE" \
#     -d email="shippotle@goshippo.com"\
#     -d validate=true

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/addresses/"
CkHttpRequest_put_ContentType $req "application/x-www-form-urlencoded"
CkHttpRequest_AddParam $req "name" "Shawn Ippotle"
CkHttpRequest_AddParam $req "company" "Shippo"
CkHttpRequest_AddParam $req "street1" "Kortrijksesteenweg 1005"
CkHttpRequest_AddParam $req "city" "Gent"
CkHttpRequest_AddParam $req "zip" "9000"
CkHttpRequest_AddParam $req "country" "BE"
CkHttpRequest_AddParam $req "email" "shippotle@goshippo.com"
CkHttpRequest_AddParam $req "validate" "true"

CkHttpRequest_AddHeader $req "Authorization" "ShippoToken <API_TOKEN>"

set resp [new_CkHttpResponse]

set success [CkHttp_HttpReq $http "https://api.goshippo.com/addresses/" $req $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    exit
}

set sbResponseBody [new_CkStringBuilder]

CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]

CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0

puts "Response Body:"
puts [CkJsonObject_emit $jResp]

set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
    puts "Response Header:"
    puts [CkHttpResponse_header $resp]
    puts "Failed."
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkHttpResponse $resp
    delete_CkStringBuilder $sbResponseBody
    delete_CkJsonObject $jResp
    exit
}

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "object_created": "2017-07-26T17:52:37.305Z",
#   "object_updated": "2017-07-26T17:52:37.351Z",
#   "object_id": "b7f9709df3914d1ca6efe4c30e7b0572",
#   "is_complete": true,
#   "validation_results": {
#     "is_valid": true,
#     "messages": [
#       {
#         "source": "Shippo Address Validator",
#         "type": "address_correction",
#         "code": "administrative_area_change",
#         "text": "The administrative area (state or province) was added or changed."
#       },
#       {
#         "source": "Shippo Address Validator",
#         "code": "geocoded_rooftop",
#         "text": "The record was geocoded down to rooftop level, meaning the point is within the property boundaries (most often the center)."
#       },
#       {
#         "source": "Shippo Address Validator",
#         "code": "premises_full",
#         "text": "The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data."
#       }
#     ]
#   },
#   "object_owner": "hippo@goshippo.com",
#   "name": "Hippo Shippo",
#   "company": "Shippo",
#   "street_no": "2",
#   "street1": "Unter den Linden",
#   "street2": "",
#   "street3": "",
#   "city": "Berlin",
#   "state": "",
#   "zip": "10117",
#   "country": "DE",
#   "longitude": "13.39751",
#   "latitude": "52.51785",
#   "phone": "14151234567",
#   "email": "hippo@goshippo.com",
#   "is_residential": null,
#   "metadata": "",
#   "test": false
# }

# Sample code for parsing the JSON response...
# Use the following online tool to generate parsing code from sample JSON:
# Generate Parsing Code from JSON

set object_created [CkJsonObject_stringOf $jResp "object_created"]
set object_updated [CkJsonObject_stringOf $jResp "object_updated"]
set object_id [CkJsonObject_stringOf $jResp "object_id"]
set is_complete [CkJsonObject_BoolOf $jResp "is_complete"]
set validation_resultsIs_valid [CkJsonObject_BoolOf $jResp "validation_results.is_valid"]
set object_owner [CkJsonObject_stringOf $jResp "object_owner"]
set name [CkJsonObject_stringOf $jResp "name"]
set company [CkJsonObject_stringOf $jResp "company"]
set street_no [CkJsonObject_stringOf $jResp "street_no"]
set street1 [CkJsonObject_stringOf $jResp "street1"]
set street2 [CkJsonObject_stringOf $jResp "street2"]
set street3 [CkJsonObject_stringOf $jResp "street3"]
set city [CkJsonObject_stringOf $jResp "city"]
set state [CkJsonObject_stringOf $jResp "state"]
set zip [CkJsonObject_stringOf $jResp "zip"]
set country [CkJsonObject_stringOf $jResp "country"]
set longitude [CkJsonObject_stringOf $jResp "longitude"]
set latitude [CkJsonObject_stringOf $jResp "latitude"]
set phone [CkJsonObject_stringOf $jResp "phone"]
set email [CkJsonObject_stringOf $jResp "email"]
set is_residential [CkJsonObject_stringOf $jResp "is_residential"]
set metadata [CkJsonObject_stringOf $jResp "metadata"]
set test [CkJsonObject_BoolOf $jResp "test"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "validation_results.messages"]
while {$i < $count_i} {
    CkJsonObject_put_I $jResp $i
    set source [CkJsonObject_stringOf $jResp "validation_results.messages[i].source"]
    set v_type [CkJsonObject_stringOf $jResp "validation_results.messages[i].type"]
    set code [CkJsonObject_stringOf $jResp "validation_results.messages[i].code"]
    set text [CkJsonObject_stringOf $jResp "validation_results.messages[i].text"]
    set i [expr $i + 1]
}

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkHttpResponse $resp
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp