delphiDll / ShipEngine Walkthrough / Validate an address (corrected)
Back to Collection Items
var
http: HCkHttp;
success: Boolean;
jarr: HCkJsonArray;
jsonObj_1: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jarrResp: HCkJsonArray;
respStatusCode: Integer;
json: HCkJsonObject;
status: PWideChar;
Name: PWideChar;
Phone: PWideChar;
Company_name: PWideChar;
Address_line1: PWideChar;
Address_line2: PWideChar;
Address_line3: PWideChar;
City_locality: PWideChar;
State_province: PWideChar;
Postal_code: PWideChar;
Country_code: PWideChar;
Address_residential_indicator: PWideChar;
matched_addressName: PWideChar;
matched_addressPhone: PWideChar;
matched_addressCompany_name: PWideChar;
matched_addressAddress_line1: PWideChar;
matched_addressAddress_line2: PWideChar;
matched_addressAddress_line3: PWideChar;
matched_addressCity_locality: PWideChar;
matched_addressState_province: PWideChar;
matched_addressPostal_code: PWideChar;
matched_addressCountry_code: PWideChar;
matched_addressAddress_residential_indicator: PWideChar;
j: Integer;
count_j: Integer;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// [
// {
// "address_line1": "525 S Winchester Blvd",
// "city_locality": "Austin",
// "state_province": "Texas",
// "postal_code": "95128",
// "country_code": "US"
// }
// ]
jarr := CkJsonArray_Create();
CkJsonArray_AddObjectAt(jarr,-1);
jsonObj_1 := CkJsonArray_ObjectAt(jarr,CkJsonArray_getSize(jarr) - 1);
CkJsonObject_UpdateString(jsonObj_1,'address_line1','525 S Winchester Blvd');
CkJsonObject_UpdateString(jsonObj_1,'city_locality','Austin');
CkJsonObject_UpdateString(jsonObj_1,'state_province','Texas');
CkJsonObject_UpdateString(jsonObj_1,'postal_code','95128');
CkJsonObject_UpdateString(jsonObj_1,'country_code','US');
CkJsonObject_Dispose(jsonObj_1);
CkHttp_SetRequestHeader(http,'API-Key','{{API_KEY}}');
CkHttp_SetRequestHeader(http,'Content-Type','application/json');
sbRequestBody := CkStringBuilder_Create();
CkJsonArray_EmitSb(jarr,sbRequestBody);
resp := CkHttp_PTextSb(http,'POST','https://api.shipengine.com/v1/addresses/validate',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jarrResp := CkJsonArray_Create();
CkJsonArray_LoadSb(jarrResp,sbResponseBody);
CkJsonArray_putEmitCompact(jarrResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonArray__emit(jarrResp));
respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttpResponse__header(resp));
Memo1.Lines.Add('Failed.');
CkHttpResponse_Dispose(resp);
Exit;
end;
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "status": "verified",
// "original_address": {
// "name": null,
// "phone": null,
// "company_name": null,
// "address_line1": "525 S Winchester Blvd",
// "address_line2": null,
// "address_line3": null,
// "city_locality": "Austin",
// "state_province": "Texas",
// "postal_code": "95128",
// "country_code": "US",
// "address_residential_indicator": "unknown"
// },
// "matched_address": {
// "name": null,
// "phone": null,
// "company_name": null,
// "address_line1": "525 S WINCHESTER BLVD",
// "address_line2": "",
// "address_line3": null,
// "city_locality": "SAN JOSE",
// "state_province": "CA",
// "postal_code": "95128-2537",
// "country_code": "US",
// "address_residential_indicator": "no"
// },
// "messages": [
// ]
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
i := 0;
count_i := CkJsonArray_getSize(jarrResp);
while i < count_i do
begin
json := CkJsonArray_ObjectAt(jarrResp,i);
status := CkJsonObject__stringOf(json,'status');
Name := CkJsonObject__stringOf(json,'original_address.name');
Phone := CkJsonObject__stringOf(json,'original_address.phone');
Company_name := CkJsonObject__stringOf(json,'original_address.company_name');
Address_line1 := CkJsonObject__stringOf(json,'original_address.address_line1');
Address_line2 := CkJsonObject__stringOf(json,'original_address.address_line2');
Address_line3 := CkJsonObject__stringOf(json,'original_address.address_line3');
City_locality := CkJsonObject__stringOf(json,'original_address.city_locality');
State_province := CkJsonObject__stringOf(json,'original_address.state_province');
Postal_code := CkJsonObject__stringOf(json,'original_address.postal_code');
Country_code := CkJsonObject__stringOf(json,'original_address.country_code');
Address_residential_indicator := CkJsonObject__stringOf(json,'original_address.address_residential_indicator');
matched_addressName := CkJsonObject__stringOf(json,'matched_address.name');
matched_addressPhone := CkJsonObject__stringOf(json,'matched_address.phone');
matched_addressCompany_name := CkJsonObject__stringOf(json,'matched_address.company_name');
matched_addressAddress_line1 := CkJsonObject__stringOf(json,'matched_address.address_line1');
matched_addressAddress_line2 := CkJsonObject__stringOf(json,'matched_address.address_line2');
matched_addressAddress_line3 := CkJsonObject__stringOf(json,'matched_address.address_line3');
matched_addressCity_locality := CkJsonObject__stringOf(json,'matched_address.city_locality');
matched_addressState_province := CkJsonObject__stringOf(json,'matched_address.state_province');
matched_addressPostal_code := CkJsonObject__stringOf(json,'matched_address.postal_code');
matched_addressCountry_code := CkJsonObject__stringOf(json,'matched_address.country_code');
matched_addressAddress_residential_indicator := CkJsonObject__stringOf(json,'matched_address.address_residential_indicator');
j := 0;
count_j := CkJsonObject_SizeOfArray(json,'messages');
while j < count_j do
begin
CkJsonObject_putJ(json,j);
j := j + 1;
end;
CkJsonObject_Dispose(json);
i := i + 1;
end;
CkHttp_Dispose(http);
CkJsonArray_Dispose(jarr);
CkStringBuilder_Dispose(sbRequestBody);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonArray_Dispose(jarrResp);
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '[
{
"address_line1": "525 S Winchester Blvd",
"city_locality": "Austin",
"state_province": "Texas",
"postal_code": "95128",
"country_code": "US"
}
]'
https://api.shipengine.com/v1/addresses/validate
Postman Collection Item JSON
{
"name": "Validate an address (corrected)",
"event": [
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\"city_locality\": \"Austin\",\n\t\t\"state_province\": \"Texas\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"US\"\n\t}\n]"
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
},
"description": "This request demonstrates ShipEngine's ability to automatically correct some addresses. In this case, the `city_locality` and `state_province` do not match the `postal_code`, and ShipEngine is able to determine that the _correct_ values are San Jose, California\". We're able to determine this because there is no \"525 S Winchester Blvd\" in Austin, Texas, but there _is_ one in San Jose, California, which matches the `postal_code`. However, if the street address had been a valid Austin address (such as 4009 Marathon Blvd), then the `postal_code` would have been corrected instead."
},
"response": [
{
"name": "Validate an address (corrected)",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "[\n\t{\n\t\t\"address_line1\": \"525 S Winchester Blvd\",\n\t\t\"city_locality\": \"Austin\",\n\t\t\"state_province\": \"Texas\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"US\"\n\t}\n]",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/validate",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"validate"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 14:23:14 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Content-Length",
"value": "845"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "x-shipengine-requestid",
"value": "cf2d5c37-0db3-4b7c-9547-f77f5586410b"
}
],
"cookie": [
],
"body": "[\n {\n \"status\": \"verified\",\n \"original_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S Winchester Blvd\",\n \"address_line2\": null,\n \"address_line3\": null,\n \"city_locality\": \"Austin\",\n \"state_province\": \"Texas\",\n \"postal_code\": \"95128\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"unknown\"\n },\n \"matched_address\": {\n \"name\": null,\n \"phone\": null,\n \"company_name\": null,\n \"address_line1\": \"525 S WINCHESTER BLVD\",\n \"address_line2\": \"\",\n \"address_line3\": null,\n \"city_locality\": \"SAN JOSE\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128-2537\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"no\"\n },\n \"messages\": []\n }\n]"
}
]
}
