Perl

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. Perl

use chilkat();

$success = 0;

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

$http = chilkat::CkHttp->new();

# 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

$req = chilkat::CkHttpRequest->new();
$req->put_HttpVerb("POST");
$req->put_Path("/addresses/");
$req->put_ContentType("application/x-www-form-urlencoded");
$req->AddParam("name","Shawn Ippotle");
$req->AddParam("company","Shippo");
$req->AddParam("street1","Kortrijksesteenweg 1005");
$req->AddParam("city","Gent");
$req->AddParam("zip","9000");
$req->AddParam("country","BE");
$req->AddParam("email",'shippotle@goshippo.com');
$req->AddParam("validate","true");

$req->AddHeader("Authorization","ShippoToken <API_TOKEN>");

$resp = chilkat::CkHttpResponse->new();
$success = $http->HttpReq("https://api.goshippo.com/addresses/",$req,$resp);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$sbResponseBody = chilkat::CkStringBuilder->new();
$resp->GetBodySb($sbResponseBody);
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $resp->get_StatusCode();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $resp->header() . "\r\n";
    print "Failed." . "\r\n";
    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

$object_created = $jResp->stringOf("object_created");
$object_updated = $jResp->stringOf("object_updated");
$object_id = $jResp->stringOf("object_id");
$is_complete = $jResp->BoolOf("is_complete");
$validation_resultsIs_valid = $jResp->BoolOf("validation_results.is_valid");
$object_owner = $jResp->stringOf("object_owner");
$name = $jResp->stringOf("name");
$company = $jResp->stringOf("company");
$street_no = $jResp->stringOf("street_no");
$street1 = $jResp->stringOf("street1");
$street2 = $jResp->stringOf("street2");
$street3 = $jResp->stringOf("street3");
$city = $jResp->stringOf("city");
$state = $jResp->stringOf("state");
$zip = $jResp->stringOf("zip");
$country = $jResp->stringOf("country");
$longitude = $jResp->stringOf("longitude");
$latitude = $jResp->stringOf("latitude");
$phone = $jResp->stringOf("phone");
$email = $jResp->stringOf("email");
$is_residential = $jResp->stringOf("is_residential");
$metadata = $jResp->stringOf("metadata");
$test = $jResp->BoolOf("test");
$i = 0;
$count_i = $jResp->SizeOfArray("validation_results.messages");
while ($i < $count_i) {
    $jResp->put_I($i);
    $source = $jResp->stringOf("validation_results.messages[i].source");
    $v_type = $jResp->stringOf("validation_results.messages[i].type");
    $code = $jResp->stringOf("validation_results.messages[i].code");
    $text = $jResp->stringOf("validation_results.messages[i].text");
    $i = $i + 1;
}