Gyda'r pwynt terfyn hawdd ei ddefnyddio hwn fe gewch restr o godau post sydd o fewn pellter penodol. Bydd yr enghraifft cais yn dychwelyd rhestr o godau post unigryw, rhestr gyflawn o godau post a manylion pob cod post.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=usMae ein API yn derbyn mesuriadau pellter mewn cilometrau (Diofyn) neu filltiroedd.
I newid mesuriad i gilometrau rhaid i chi roi'r ms yn eich cais:
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=usBydd yr ymateb yn edrych fel hyn:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...],
"range_codes": ["07010", "07020", "07022", "07024", "07026", ...],
"range_codes_details": [
{
"postal_code":"07010",
"country_code":"US",
"city":"Cliffside Park",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07020",
"country_code":"US",
"city":"Edgewater",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07022",
"country_code":"US",
"city":"Fairview",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07024",
"country_code":"US",
"city":"Fort Lee",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
{
"postal_code":"07026",
"country_code":"US",
"city":"Garfield",
"state":"New Jersey",
"state_code":"NJ",
"province":"Bergen",
"province_code":"003"
},
...
],
}
}
Bydd yr enghraifft ganlynol yn dychwelyd manylion y codau post sy'n cyd-fynd â'r ymholiad chwilio.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=usBydd yr ymateb yn edrych fel hyn:
{
"query":{
"code": "10005",
"country": "us",
"range": "",
"measure": ""
},
"results":{
"range_codes_unique": ["10005"],
"range_codes": ["10005"],
"range_codes_details": [
{
"postal_code":"10005",
"country_code":"US",
"city":"New York",
"state":"New York",
"state_code":"NY",
"province":"New York",
"province_code":"061"
}
],
}
}
Gallwch basio params ychwanegol i gael dim ond yr hyn sydd ei angen arnoch chi yn y canlyniadau, dim ond ychwanegu'r fields gwerth yn eich cais.
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=usBydd yr ymateb yn edrych fel hyn:
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}