Chilkat Online Tools

C / ShipEngine Walkthrough / Validate an address (valid)

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonArray.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonArray jarr;
    HCkJsonObject jsonObj_1;
    HCkStringBuilder sbRequestBody;
    HCkHttpResponse resp;
    HCkStringBuilder sbResponseBody;
    HCkJsonArray jarrResp;
    int respStatusCode;
    HCkJsonObject json;
    const char *status;
    const char *Name;
    const char *Phone;
    const char *Company_name;
    const char *Address_line1;
    const char *Address_line2;
    const char *Address_line3;
    const char *City_locality;
    const char *State_province;
    const char *Postal_code;
    const char *Country_code;
    const char *Address_residential_indicator;
    const char *matched_addressName;
    const char *matched_addressPhone;
    const char *matched_addressCompany_name;
    const char *matched_addressAddress_line1;
    const char *matched_addressAddress_line2;
    const char *matched_addressAddress_line3;
    const char *matched_addressCity_locality;
    const char *matched_addressState_province;
    const char *matched_addressPostal_code;
    const char *matched_addressCountry_code;
    const char *matched_addressAddress_residential_indicator;
    int j;
    int count_j;
    int i;
    int count_i;

    // 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": "San Jose",
    //     "state_province": "CA",
    //     "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","San Jose");
    CkJsonObject_UpdateString(jsonObj_1,"state_province","CA");
    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) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonArray_Dispose(jarr);
        CkStringBuilder_Dispose(sbRequestBody);
        return;
    }

    sbResponseBody = CkStringBuilder_Create();
    CkHttpResponse_GetBodySb(resp,sbResponseBody);

    jarrResp = CkJsonArray_Create();
    CkJsonArray_LoadSb(jarrResp,sbResponseBody);
    CkJsonArray_putEmitCompact(jarrResp,FALSE);

    printf("Response Body:\n");
    printf("%s\n",CkJsonArray_emit(jarrResp));

    respStatusCode = CkHttpResponse_getStatusCode(resp);
    printf("Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        printf("Response Header:\n");
        printf("%s\n",CkHttpResponse_header(resp));
        printf("Failed.\n");
        CkHttpResponse_Dispose(resp);
        CkHttp_Dispose(http);
        CkJsonArray_Dispose(jarr);
        CkStringBuilder_Dispose(sbRequestBody);
        CkStringBuilder_Dispose(sbResponseBody);
        CkJsonArray_Dispose(jarrResp);
        return;
    }

    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": "San Jose",
    //       "state_province": "CA",
    //       "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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    i = 0;
    count_i = CkJsonArray_getSize(jarrResp);
    while (i < count_i) {
        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) {
            CkJsonObject_putJ(json,j);
            j = j + 1;
        }

        CkJsonObject_Dispose(json);
        i = i + 1;
    }



    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": "San Jose",
		"state_province": "CA",
		"postal_code": "95128",
		"country_code": "US"
	}
]'
https://api.shipengine.com/v1/addresses/validate

Postman Collection Item JSON

{
  "name": "Validate an address (valid)",
  "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\": \"US\"\n\t}\n]"
    },
    "url": {
      "raw": "https://api.shipengine.com/v1/addresses/validate",
      "protocol": "https",
      "host": [
        "api",
        "shipengine",
        "com"
      ],
      "path": [
        "v1",
        "addresses",
        "validate"
      ]
    },
    "description": "ShipEngine supports address validation for nearly every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others."
  },
  "response": [
    {
      "name": "Validate an address (valid)",
      "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\": \"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:06:22 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json; charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "844"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Access-Control-Allow-Origin",
          "value": "https://www.shipengine.com"
        },
        {
          "key": "Vary",
          "value": "Origin"
        },
        {
          "key": "x-shipengine-requestid",
          "value": "241f9781-18b7-4c54-b872-8e29c04b4c9e"
        }
      ],
      "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\": \"San Jose\",\n            \"state_province\": \"CA\",\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]"
    }
  ]
}