DataFlex
DataFlex
Shippo Validate Global Address
See more Shippo Examples
Demonstrates how to validate a global address.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Variant vReq
Handle hoReq
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sSource
String sV_type
String sCode
String sText
String sObject_created
String sObject_updated
String sObject_id
Boolean iIs_complete
Boolean iValidation_resultsIs_valid
String sObject_owner
String sName
String sCompany
String sStreet_no
String sStreet1
String sStreet2
String sStreet3
String sCity
String sState
String sZip
String sCountry
String sLongitude
String sLatitude
String sPhone
String sEmail
String sIs_residential
String sMetadata
Boolean iTest
Integer i
Integer iCount_i
String sTemp1
Move False To iSuccess
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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
Get Create (RefClass(cComChilkatHttpRequest)) To hoReq
If (Not(IsComObjectCreated(hoReq))) Begin
Send CreateComObject of hoReq
End
Set ComHttpVerb Of hoReq To "POST"
Set ComPath Of hoReq To "/addresses/"
Set ComContentType Of hoReq To "application/x-www-form-urlencoded"
Send ComAddParam To hoReq "name" "Shawn Ippotle"
Send ComAddParam To hoReq "company" "Shippo"
Send ComAddParam To hoReq "street1" "Kortrijksesteenweg 1005"
Send ComAddParam To hoReq "city" "Gent"
Send ComAddParam To hoReq "zip" "9000"
Send ComAddParam To hoReq "country" "BE"
Send ComAddParam To hoReq "email" "shippotle@goshippo.com"
Send ComAddParam To hoReq "validate" "true"
Send ComAddHeader To hoReq "Authorization" "ShippoToken <API_TOKEN>"
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
If (Not(IsComObjectCreated(hoResp))) Begin
Send CreateComObject of hoResp
End
Get pvComObject of hoReq to vReq
Get pvComObject of hoResp to vResp
Get ComHttpReq Of hoHttp "https://api.goshippo.com/addresses/" vReq vResp To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// 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
Get ComStringOf Of hoJResp "object_created" To sObject_created
Get ComStringOf Of hoJResp "object_updated" To sObject_updated
Get ComStringOf Of hoJResp "object_id" To sObject_id
Get ComBoolOf Of hoJResp "is_complete" To iIs_complete
Get ComBoolOf Of hoJResp "validation_results.is_valid" To iValidation_resultsIs_valid
Get ComStringOf Of hoJResp "object_owner" To sObject_owner
Get ComStringOf Of hoJResp "name" To sName
Get ComStringOf Of hoJResp "company" To sCompany
Get ComStringOf Of hoJResp "street_no" To sStreet_no
Get ComStringOf Of hoJResp "street1" To sStreet1
Get ComStringOf Of hoJResp "street2" To sStreet2
Get ComStringOf Of hoJResp "street3" To sStreet3
Get ComStringOf Of hoJResp "city" To sCity
Get ComStringOf Of hoJResp "state" To sState
Get ComStringOf Of hoJResp "zip" To sZip
Get ComStringOf Of hoJResp "country" To sCountry
Get ComStringOf Of hoJResp "longitude" To sLongitude
Get ComStringOf Of hoJResp "latitude" To sLatitude
Get ComStringOf Of hoJResp "phone" To sPhone
Get ComStringOf Of hoJResp "email" To sEmail
Get ComStringOf Of hoJResp "is_residential" To sIs_residential
Get ComStringOf Of hoJResp "metadata" To sMetadata
Get ComBoolOf Of hoJResp "test" To iTest
Move 0 To i
Get ComSizeOfArray Of hoJResp "validation_results.messages" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "validation_results.messages[i].source" To sSource
Get ComStringOf Of hoJResp "validation_results.messages[i].type" To sV_type
Get ComStringOf Of hoJResp "validation_results.messages[i].code" To sCode
Get ComStringOf Of hoJResp "validation_results.messages[i].text" To sText
Move (i + 1) To i
Loop
End_Procedure