Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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"
; }
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(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::ckUpdateString(json,"address.country_code","US")
CkHttp::ckSetRequestHeader(http,"API-Key","{{API_KEY}}")
CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")
resp.i = CkHttp::ckPostJson3(http,"https://api.shipengine.com/v1/addresses/recognize","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
v_type.s
text.s
start_index.i
end_index.i
Value.s
Line.i
v_Type.s
resultName.s
score.s = CkJsonObject::ckStringOf(jResp,"score")
Name.s = CkJsonObject::ckStringOf(jResp,"address.name")
Address_line1.s = CkJsonObject::ckStringOf(jResp,"address.address_line1")
City_locality.s = CkJsonObject::ckStringOf(jResp,"address.city_locality")
State_province.s = CkJsonObject::ckStringOf(jResp,"address.state_province")
Postal_code.s = CkJsonObject::ckStringOf(jResp,"address.postal_code")
Country_code.s = CkJsonObject::ckStringOf(jResp,"address.country_code")
Address_residential_indicator.s = CkJsonObject::ckStringOf(jResp,"address.address_residential_indicator")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"entities")
While i < count_i
CkJsonObject::setCkI(jResp, i)
v_type = CkJsonObject::ckStringOf(jResp,"entities[i].type")
score = CkJsonObject::ckStringOf(jResp,"entities[i].score")
text = CkJsonObject::ckStringOf(jResp,"entities[i].text")
start_index = CkJsonObject::ckIntOf(jResp,"entities[i].start_index")
end_index = CkJsonObject::ckIntOf(jResp,"entities[i].end_index")
Value = CkJsonObject::ckStringOf(jResp,"entities[i].result.value")
Line = CkJsonObject::ckIntOf(jResp,"entities[i].result.line")
v_Type = CkJsonObject::ckStringOf(jResp,"entities[i].result.type")
resultName = CkJsonObject::ckStringOf(jResp,"entities[i].result.name")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
