Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Use this online tool to generate code from sample JSON: Generate Code to Create JSON
# The following JSON is sent in the request body.
# {
# "text": "I need to send a package to my friend Amanda Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128.",
# "address": {
# "country_code": "US"
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "text" "I need to send a package to my friend Amanda Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128."
CkJsonObject_UpdateString $json "address.country_code" "US"
CkHttp_SetRequestHeader $http "API-Key" "{{API_KEY}}"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://api.shipengine.com/v1/addresses/recognize" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
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_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "score": 0.9710697187242877,
# "address": {
# "name": "Amanda Miller",
# "address_line1": "525 Winchester Blvd",
# "city_locality": "San Jose",
# "state_province": "CA",
# "postal_code": "95128",
# "country_code": "US",
# "address_residential_indicator": "yes"
# },
# "entities": [
# {
# "type": "person",
# "score": 0.9519646137063122,
# "text": "Amanda Miller",
# "start_index": 38,
# "end_index": 50,
# "result": {
# "value": "Amanda Miller"
# }
# },
# {
# "type": "residential_indicator",
# "score": 0.9519646137063122,
# "text": "house",
# "start_index": 54,
# "end_index": 58,
# "result": {
# "value": "yes"
# }
# },
# {
# "type": "address_line",
# "score": 0.9805313966503588,
# "text": "525 Winchester Blvd",
# "start_index": 63,
# "end_index": 81,
# "result": {
# "line": 1,
# "value": "525 Winchester Blvd"
# }
# },
# {
# "type": "number",
# "score": 0.9805313966503588,
# "text": "525",
# "start_index": 63,
# "end_index": 65,
# "result": {
# "type": "cardinal",
# "value": 525
# }
# },
# {
# "type": "city_locality",
# "score": 0.9805313966503588,
# "text": "San Jose",
# "start_index": 86,
# "end_index": 93,
# "result": {
# "value": "San Jose"
# }
# },
# {
# "type": "state_province",
# "score": 0.9805313966503588,
# "text": "california",
# "start_index": 103,
# "end_index": 112,
# "result": {
# "name": "California",
# "value": "CA"
# }
# },
# {
# "type": "postal_code",
# "score": 0.9519646137063122,
# "text": "95128",
# "start_index": 149,
# "end_index": 153,
# "result": {
# "value": "95128"
# }
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set score [CkJsonObject_stringOf $jResp "score"]
set Name [CkJsonObject_stringOf $jResp "address.name"]
set Address_line1 [CkJsonObject_stringOf $jResp "address.address_line1"]
set City_locality [CkJsonObject_stringOf $jResp "address.city_locality"]
set State_province [CkJsonObject_stringOf $jResp "address.state_province"]
set Postal_code [CkJsonObject_stringOf $jResp "address.postal_code"]
set Country_code [CkJsonObject_stringOf $jResp "address.country_code"]
set Address_residential_indicator [CkJsonObject_stringOf $jResp "address.address_residential_indicator"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "entities"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set v_type [CkJsonObject_stringOf $jResp "entities[i].type"]
set score [CkJsonObject_stringOf $jResp "entities[i].score"]
set text [CkJsonObject_stringOf $jResp "entities[i].text"]
set start_index [CkJsonObject_IntOf $jResp "entities[i].start_index"]
set end_index [CkJsonObject_IntOf $jResp "entities[i].end_index"]
set Value [CkJsonObject_stringOf $jResp "entities[i].result.value"]
set Line [CkJsonObject_IntOf $jResp "entities[i].result.line"]
set v_Type [CkJsonObject_stringOf $jResp "entities[i].result.type"]
set resultName [CkJsonObject_stringOf $jResp "entities[i].result.name"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "API-Key: {{API_KEY}}"
-H "Content-Type: application/json"
-d '{
"text": "I need to send a package to my friend Amanda Miller’s house at 525 Winchester Blvd in San Jose (that\'s california, obviously). The zip code there is 95128.",
"address": {
"country_code": "US"
}
}'
https://api.shipengine.com/v1/addresses/recognize
Postman Collection Item JSON
{
"name": "Already-known fields",
"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\"text\": \"I need to send a package to my friend Amanda Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128.\",\n\t\"address\": {\n\t\t\"country_code\": \"US\"\n\t}\n}"
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"recognize"
]
},
"description": "If you already know some parts of the address, you can provide them to ShipEngine, and we'll use those values. These values can also help us recognize other parts of the address."
},
"response": [
{
"name": "Already-known fields",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"name": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n\t\"text\": \"I need to send a package to my friend Amanda Miller’s house at 525 Winchester Blvd in San Jose (that's california, obviously). The zip code there is 95128.\",\n\t\"address\": {\n\t\t\"country_code\": \"US\"\n\t}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.shipengine.com/v1/addresses/recognize",
"protocol": "https",
"host": [
"api",
"shipengine",
"com"
],
"path": [
"v1",
"addresses",
"recognize"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 18 Sep 2019 16:21:30 GMT"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Access-Control-Allow-Origin",
"value": "https://www.shipengine.com"
},
{
"key": "Vary",
"value": "Origin"
},
{
"key": "content-encoding",
"value": "gzip"
}
],
"cookie": [
],
"body": "{\n \"score\": 0.9710697187242877,\n \"address\": {\n \"name\": \"Amanda Miller\",\n \"address_line1\": \"525 Winchester Blvd\",\n \"city_locality\": \"San Jose\",\n \"state_province\": \"CA\",\n \"postal_code\": \"95128\",\n \"country_code\": \"US\",\n \"address_residential_indicator\": \"yes\"\n },\n \"entities\": [\n {\n \"type\": \"person\",\n \"score\": 0.9519646137063122,\n \"text\": \"Amanda Miller\",\n \"start_index\": 38,\n \"end_index\": 50,\n \"result\": {\n \"value\": \"Amanda Miller\"\n }\n },\n {\n \"type\": \"residential_indicator\",\n \"score\": 0.9519646137063122,\n \"text\": \"house\",\n \"start_index\": 54,\n \"end_index\": 58,\n \"result\": {\n \"value\": \"yes\"\n }\n },\n {\n \"type\": \"address_line\",\n \"score\": 0.9805313966503588,\n \"text\": \"525 Winchester Blvd\",\n \"start_index\": 63,\n \"end_index\": 81,\n \"result\": {\n \"line\": 1,\n \"value\": \"525 Winchester Blvd\"\n }\n },\n {\n \"type\": \"number\",\n \"score\": 0.9805313966503588,\n \"text\": \"525\",\n \"start_index\": 63,\n \"end_index\": 65,\n \"result\": {\n \"type\": \"cardinal\",\n \"value\": 525\n }\n },\n {\n \"type\": \"city_locality\",\n \"score\": 0.9805313966503588,\n \"text\": \"San Jose\",\n \"start_index\": 86,\n \"end_index\": 93,\n \"result\": {\n \"value\": \"San Jose\"\n }\n },\n {\n \"type\": \"state_province\",\n \"score\": 0.9805313966503588,\n \"text\": \"california\",\n \"start_index\": 103,\n \"end_index\": 112,\n \"result\": {\n \"name\": \"California\",\n \"value\": \"CA\"\n }\n },\n {\n \"type\": \"postal_code\",\n \"score\": 0.9519646137063122,\n \"text\": \"95128\",\n \"start_index\": 149,\n \"end_index\": 153,\n \"result\": {\n \"value\": \"95128\"\n }\n }\n ]\n}"
}
]
}
