Swift

Shippo Validate Global Address

See more Shippo Examples

Demonstrates how to validate a global address. Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

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

    let req = CkoHttpRequest()!
    req.httpVerb = "POST"
    req.path = "/addresses/"
    req.contentType = "application/x-www-form-urlencoded"
    req.addParam(name: "name", value: "Shawn Ippotle")
    req.addParam(name: "company", value: "Shippo")
    req.addParam(name: "street1", value: "Kortrijksesteenweg 1005")
    req.addParam(name: "city", value: "Gent")
    req.addParam(name: "zip", value: "9000")
    req.addParam(name: "country", value: "BE")
    req.addParam(name: "email", value: "shippotle@goshippo.com")
    req.addParam(name: "validate", value: "true")

    req.addHeader(name: "Authorization", value: "ShippoToken <API_TOKEN>")

    let resp = CkoHttpResponse()!
    success = http.httpReq(url: "https://api.goshippo.com/addresses/", request: req, response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp.getBodySb(sb: sbResponseBody)
    let jResp = CkoJsonObject()!
    jResp.loadSb(sb: sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp.header!)")
        print("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

    var source: String?
    var v_type: String?
    var code: String?
    var text: String?

    var object_created: String? = jResp.string(of: "object_created")
    var object_updated: String? = jResp.string(of: "object_updated")
    var object_id: String? = jResp.string(of: "object_id")
    var is_complete: Bool = jResp.bool(of: "is_complete")
    var validation_resultsIs_valid: Bool = jResp.bool(of: "validation_results.is_valid")
    var object_owner: String? = jResp.string(of: "object_owner")
    var name: String? = jResp.string(of: "name")
    var company: String? = jResp.string(of: "company")
    var street_no: String? = jResp.string(of: "street_no")
    var street1: String? = jResp.string(of: "street1")
    var street2: String? = jResp.string(of: "street2")
    var street3: String? = jResp.string(of: "street3")
    var city: String? = jResp.string(of: "city")
    var state: String? = jResp.string(of: "state")
    var zip: String? = jResp.string(of: "zip")
    var country: String? = jResp.string(of: "country")
    var longitude: String? = jResp.string(of: "longitude")
    var latitude: String? = jResp.string(of: "latitude")
    var phone: String? = jResp.string(of: "phone")
    var email: String? = jResp.string(of: "email")
    var is_residential: String? = jResp.string(of: "is_residential")
    var metadata: String? = jResp.string(of: "metadata")
    var test: Bool = jResp.bool(of: "test")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "validation_results.messages").intValue
    while i < count_i {
        jResp.i = i
        source = jResp.string(of: "validation_results.messages[i].source")
        v_type = jResp.string(of: "validation_results.messages[i].type")
        code = jResp.string(of: "validation_results.messages[i].code")
        text = jResp.string(of: "validation_results.messages[i].text")
        i = i + 1
    }


}