Chilkat Online Tools

PureBasic / ShipEngine Walkthrough / Validate an address (unverified)

Back to Collection Items

IncludeFile "CkJsonArray.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
IncludeFile "CkJsonObject.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.

    ; [
    ;   {
    ;     "address_line1": "525 S Winchester Blvd",
    ;     "city_locality": "San Jose",
    ;     "state_province": "CA",
    ;     "postal_code": "95128",
    ;     "country_code": "USA"
    ;   }
    ; ]

    jarr.i = CkJsonArray::ckCreate()
    If jarr.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckAddObjectAt(jarr,-1)
    jsonObj_1.i = CkJsonArray::ckObjectAt(jarr,CkJsonArray::ckSize(jarr) - 1)
    CkJsonObject::ckUpdateString(jsonObj_1,"address_line1","525 S Winchester Blvd")
    CkJsonObject::ckUpdateString(jsonObj_1,"city_locality","San Jose")
    CkJsonObject::ckUpdateString(jsonObj_1,"state_province","CA")
    CkJsonObject::ckUpdateString(jsonObj_1,"postal_code","95128")
    CkJsonObject::ckUpdateString(jsonObj_1,"country_code","USA")
    CkJsonObject::ckDispose(jsonObj_1)

    CkHttp::ckSetRequestHeader(http,"API-Key","{{API_KEY}}")
    CkHttp::ckSetRequestHeader(http,"Content-Type","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckEmitSb(jarr,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"POST","https://api.shipengine.com/v1/addresses/validate",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonArray::ckDispose(jarr)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpResponse::ckGetBodySb(resp,sbResponseBody)

    jarrResp.i = CkJsonArray::ckCreate()
    If jarrResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonArray::ckLoadSb(jarrResp,sbResponseBody)
    CkJsonArray::setCkEmitCompact(jarrResp, 0)

    Debug "Response Body:"
    Debug CkJsonArray::ckEmit(jarrResp)

    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)
        CkJsonArray::ckDispose(jarr)
        CkStringBuilder::ckDispose(sbRequestBody)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonArray::ckDispose(jarrResp)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

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

    ; [
    ;   {
    ;     "status": "unverified",
    ;     "original_address": {
    ;       "name": null,
    ;       "phone": null,
    ;       "company_name": null,
    ;       "address_line1": "525 S Winchester Blvd",
    ;       "address_line2": null,
    ;       "address_line3": null,
    ;       "city_locality": "San Jose",
    ;       "state_province": "CA",
    ;       "postal_code": "95128",
    ;       "country_code": "USA",
    ;       "address_residential_indicator": "unknown"
    ;     },
    ;     "matched_address": null,
    ;     "messages": [
    ;       {
    ;         "code": "a1005",
    ;         "message": "Length of property 'country_code' must equal exactly 2",
    ;         "type": "error",
    ;         "detail_code": "country_invalid_length"
    ;       },
    ;       {
    ;         "code": "a1001",
    ;         "message": "country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.",
    ;         "type": "error",
    ;         "detail_code": "unsupported_country"
    ;       }
    ;     ]
    ;   }
    ; ]

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

    json.i
    status.s
    Name.s
    Phone.s
    Company_name.s
    Address_line1.s
    Address_line2.s
    Address_line3.s
    City_locality.s
    State_province.s
    Postal_code.s
    Country_code.s
    Address_residential_indicator.s
    matched_address.s
    j.i
    count_j.i
    code.s
    message.s
    v_type.s
    detail_code.s

    i.i = 0
    count_i.i = CkJsonArray::ckSize(jarrResp)
    While i < count_i
        json = CkJsonArray::ckObjectAt(jarrResp,i)
        status = CkJsonObject::ckStringOf(json,"status")
        Name = CkJsonObject::ckStringOf(json,"original_address.name")
        Phone = CkJsonObject::ckStringOf(json,"original_address.phone")
        Company_name = CkJsonObject::ckStringOf(json,"original_address.company_name")
        Address_line1 = CkJsonObject::ckStringOf(json,"original_address.address_line1")
        Address_line2 = CkJsonObject::ckStringOf(json,"original_address.address_line2")
        Address_line3 = CkJsonObject::ckStringOf(json,"original_address.address_line3")
        City_locality = CkJsonObject::ckStringOf(json,"original_address.city_locality")
        State_province = CkJsonObject::ckStringOf(json,"original_address.state_province")
        Postal_code = CkJsonObject::ckStringOf(json,"original_address.postal_code")
        Country_code = CkJsonObject::ckStringOf(json,"original_address.country_code")
        Address_residential_indicator = CkJsonObject::ckStringOf(json,"original_address.address_residential_indicator")
        matched_address = CkJsonObject::ckStringOf(json,"matched_address")
        j = 0
        count_j = CkJsonObject::ckSizeOfArray(json,"messages")
        While j < count_j
            CkJsonObject::setCkJ(json, j)
            code = CkJsonObject::ckStringOf(json,"messages[j].code")
            message = CkJsonObject::ckStringOf(json,"messages[j].message")
            v_type = CkJsonObject::ckStringOf(json,"messages[j].type")
            detail_code = CkJsonObject::ckStringOf(json,"messages[j].detail_code")
            j = j + 1
        Wend
        CkJsonObject::ckDispose(json)

        i = i + 1
    Wend


    CkHttp::ckDispose(http)
    CkJsonArray::ckDispose(jarr)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonArray::ckDispose(jarrResp)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "API-Key: {{API_KEY}}"
	-H "Content-Type: application/json"
	-d '[
	{
		"address_line1": "525 S Winchester Blvd",
		"city_locality": "San Jose",
		"state_province": "CA",
		"postal_code": "95128",
		"country_code": "USA"
	}
]'
https://api.shipengine.com/v1/addresses/validate

Postman Collection Item JSON

{
  "name": "Validate an address (unverified)",
  "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\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\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 shows how ShipEngine responds when an address cannot be verified. The `status` field is `unverified`, and the `messages` array lists the problems with the address."
  },
  "response": [
    {
      "name": "Validate an address (unverified)",
      "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\": \"San Jose\",\n\t\t\"state_province\": \"CA\",\n\t\t\"postal_code\": \"95128\",\n\t\t\"country_code\": \"USA\"\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": "Tue, 22 Oct 2019 20:28:48 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "951"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "118b96e8-1e29-4ded-ba33-62a661e55038"
        }
      ],
      "cookie": [
      ],
      "body": "[\n    {\n        \"status\": \"unverified\",\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\": \"San Jose\",\n            \"state_province\": \"CA\",\n            \"postal_code\": \"95128\",\n            \"country_code\": \"USA\",\n            \"address_residential_indicator\": \"unknown\"\n        },\n        \"matched_address\": null,\n        \"messages\": [\n            {\n                \"code\": \"a1005\",\n                \"message\": \"Length of property 'country_code' must equal exactly 2\",\n                \"type\": \"error\",\n                \"detail_code\": \"country_invalid_length\"\n            },\n            {\n                \"code\": \"a1001\",\n                \"message\": \"country_code is not currently a supported country, please check the documentation for acceptable 2-letter country codes.\",\n                \"type\": \"error\",\n                \"detail_code\": \"unsupported_country\"\n            }\n        ]\n    }\n]"
    }
  ]
}