C
C
Shippo Validate Global Address
See more Shippo Examples
Demonstrates how to validate a global address.Chilkat C Downloads
#include <C_CkHttp.h>
#include <C_CkHttpRequest.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttp http;
HCkHttpRequest req;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *source;
const char *v_type;
const char *code;
const char *text;
const char *object_created;
const char *object_updated;
const char *object_id;
BOOL is_complete;
BOOL validation_resultsIs_valid;
const char *object_owner;
const char *name;
const char *company;
const char *street_no;
const char *street1;
const char *street2;
const char *street3;
const char *city;
const char *state;
const char *zip;
const char *country;
const char *longitude;
const char *latitude;
const char *phone;
const char *email;
const char *is_residential;
const char *metadata;
BOOL test;
int i;
int count_i;
success = FALSE;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
// Implements the following CURL command:
// curl https://api.goshippo.com/addresses/ \
// -H "Authorization: ShippoToken <API_TOKEN>" \
// -d name="Shawn Ippotle" \
// -d company="Shippo" \
// -d street1="Kortrijksesteenweg 1005" \
// -d city="Gent" \
// -d zip=9000 \
// -d country="BE" \
// -d email="shippotle@goshippo.com"\
// -d validate=true
req = CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,"POST");
CkHttpRequest_putPath(req,"/addresses/");
CkHttpRequest_putContentType(req,"application/x-www-form-urlencoded");
CkHttpRequest_AddParam(req,"name","Shawn Ippotle");
CkHttpRequest_AddParam(req,"company","Shippo");
CkHttpRequest_AddParam(req,"street1","Kortrijksesteenweg 1005");
CkHttpRequest_AddParam(req,"city","Gent");
CkHttpRequest_AddParam(req,"zip","9000");
CkHttpRequest_AddParam(req,"country","BE");
CkHttpRequest_AddParam(req,"email","shippotle@goshippo.com");
CkHttpRequest_AddParam(req,"validate","true");
CkHttpRequest_AddHeader(req,"Authorization","ShippoToken <API_TOKEN>");
resp = CkHttpResponse_Create();
success = CkHttp_HttpReq(http,"https://api.goshippo.com/addresses/",req,resp);
if (success == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkHttpResponse_Dispose(resp);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
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");
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkHttpResponse_Dispose(resp);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "object_created": "2017-07-26T17:52:37.305Z",
// "object_updated": "2017-07-26T17:52:37.351Z",
// "object_id": "b7f9709df3914d1ca6efe4c30e7b0572",
// "is_complete": true,
// "validation_results": {
// "is_valid": true,
// "messages": [
// {
// "source": "Shippo Address Validator",
// "type": "address_correction",
// "code": "administrative_area_change",
// "text": "The administrative area (state or province) was added or changed."
// },
// {
// "source": "Shippo Address Validator",
// "code": "geocoded_rooftop",
// "text": "The record was geocoded down to rooftop level, meaning the point is within the property boundaries (most often the center)."
// },
// {
// "source": "Shippo Address Validator",
// "code": "premises_full",
// "text": "The address has been verified to the Premise (House or Building) Level, which is the highest level possible with the reference data."
// }
// ]
// },
// "object_owner": "hippo@goshippo.com",
// "name": "Hippo Shippo",
// "company": "Shippo",
// "street_no": "2",
// "street1": "Unter den Linden",
// "street2": "",
// "street3": "",
// "city": "Berlin",
// "state": "",
// "zip": "10117",
// "country": "DE",
// "longitude": "13.39751",
// "latitude": "52.51785",
// "phone": "14151234567",
// "email": "hippo@goshippo.com",
// "is_residential": null,
// "metadata": "",
// "test": false
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
// See this example explaining how this memory should be used: const char * functions.
object_created = CkJsonObject_stringOf(jResp,"object_created");
object_updated = CkJsonObject_stringOf(jResp,"object_updated");
object_id = CkJsonObject_stringOf(jResp,"object_id");
is_complete = CkJsonObject_BoolOf(jResp,"is_complete");
validation_resultsIs_valid = CkJsonObject_BoolOf(jResp,"validation_results.is_valid");
object_owner = CkJsonObject_stringOf(jResp,"object_owner");
name = CkJsonObject_stringOf(jResp,"name");
company = CkJsonObject_stringOf(jResp,"company");
street_no = CkJsonObject_stringOf(jResp,"street_no");
street1 = CkJsonObject_stringOf(jResp,"street1");
street2 = CkJsonObject_stringOf(jResp,"street2");
street3 = CkJsonObject_stringOf(jResp,"street3");
city = CkJsonObject_stringOf(jResp,"city");
state = CkJsonObject_stringOf(jResp,"state");
zip = CkJsonObject_stringOf(jResp,"zip");
country = CkJsonObject_stringOf(jResp,"country");
longitude = CkJsonObject_stringOf(jResp,"longitude");
latitude = CkJsonObject_stringOf(jResp,"latitude");
phone = CkJsonObject_stringOf(jResp,"phone");
email = CkJsonObject_stringOf(jResp,"email");
is_residential = CkJsonObject_stringOf(jResp,"is_residential");
metadata = CkJsonObject_stringOf(jResp,"metadata");
test = CkJsonObject_BoolOf(jResp,"test");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"validation_results.messages");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
source = CkJsonObject_stringOf(jResp,"validation_results.messages[i].source");
v_type = CkJsonObject_stringOf(jResp,"validation_results.messages[i].type");
code = CkJsonObject_stringOf(jResp,"validation_results.messages[i].code");
text = CkJsonObject_stringOf(jResp,"validation_results.messages[i].text");
i = i + 1;
}
CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkHttpResponse_Dispose(resp);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}