Objective-C

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. Objective-C

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

BOOL success = NO;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];

// 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

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
req.HttpVerb = @"POST";
req.Path = @"/addresses/";
req.ContentType = @"application/x-www-form-urlencoded";
[req AddParam: @"name" value: @"Shawn Ippotle"];
[req AddParam: @"company" value: @"Shippo"];
[req AddParam: @"street1" value: @"Kortrijksesteenweg 1005"];
[req AddParam: @"city" value: @"Gent"];
[req AddParam: @"zip" value: @"9000"];
[req AddParam: @"country" value: @"BE"];
[req AddParam: @"email" value: @"shippotle@goshippo.com"];
[req AddParam: @"validate" value: @"true"];

[req AddHeader: @"Authorization" value: @"ShippoToken <API_TOKEN>"];

CkoHttpResponse *resp = [[CkoHttpResponse alloc] init];
success = [http HttpReq: @"https://api.goshippo.com/addresses/" request: req response: resp];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");
    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

NSString *source = 0;
NSString *v_type = 0;
NSString *code = 0;
NSString *text = 0;

NSString *object_created = [jResp StringOf: @"object_created"];
NSString *object_updated = [jResp StringOf: @"object_updated"];
NSString *object_id = [jResp StringOf: @"object_id"];
BOOL is_complete = [jResp BoolOf: @"is_complete"];
BOOL validation_resultsIs_valid = [jResp BoolOf: @"validation_results.is_valid"];
NSString *object_owner = [jResp StringOf: @"object_owner"];
NSString *name = [jResp StringOf: @"name"];
NSString *company = [jResp StringOf: @"company"];
NSString *street_no = [jResp StringOf: @"street_no"];
NSString *street1 = [jResp StringOf: @"street1"];
NSString *street2 = [jResp StringOf: @"street2"];
NSString *street3 = [jResp StringOf: @"street3"];
NSString *city = [jResp StringOf: @"city"];
NSString *state = [jResp StringOf: @"state"];
NSString *zip = [jResp StringOf: @"zip"];
NSString *country = [jResp StringOf: @"country"];
NSString *longitude = [jResp StringOf: @"longitude"];
NSString *latitude = [jResp StringOf: @"latitude"];
NSString *phone = [jResp StringOf: @"phone"];
NSString *email = [jResp StringOf: @"email"];
NSString *is_residential = [jResp StringOf: @"is_residential"];
NSString *metadata = [jResp StringOf: @"metadata"];
BOOL test = [jResp BoolOf: @"test"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"validation_results.messages"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    source = [jResp StringOf: @"validation_results.messages[i].source"];
    v_type = [jResp StringOf: @"validation_results.messages[i].type"];
    code = [jResp StringOf: @"validation_results.messages[i].code"];
    text = [jResp StringOf: @"validation_results.messages[i].text"];
    i = i + 1;
}