ဤအသုံးပြုရလွယ်ကူသော endpoint ဖြင့်အကွာအဝေးတစ်ခုအတွင်းရှိစာတိုက်သင်္ကေတများကိုသင်ရရှိလိမ့်မည်။ တောင်းဆိုမှုဥပမာသည်ထူးခြားသောစာတိုက်ကုဒ်များ၊ စာတိုက်သင်္ကေတအပြည့်အစုံနှင့်စာတိုက်သင်္ကေတတစ်ခုချင်းစီ၏အသေးစိတ်အချက်အလက်များကိုပြန်လည်ပေးပို့လိမ့်မည်။
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&distance=25&zipcode=10005&country=us
ကျွန်ုပ်တို့၏ API သည်အကွာအဝေးတိုင်းတာချက်များကိုကီလိုမီတာ (ပုံမှန်) သို့မဟုတ်မိုင်ဖြင့်လက်ခံသည်။
တိုင်းတာမှုအားကီလိုမီတာသို့ပြောင်းရန်သင်၏တောင်းဆိုချက်တွင် ms
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&ms=km&distance=25&zipcode=10005&country=us
တုန့်ပြန်ချက်သည်အောက်ပါအတိုင်းဖြစ်ပါလိမ့်မည် -
{
"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"
},
...
],
}
}
အောက်ဖော်ပြပါဥပမာသည်ရှာဖွေရေးမေးခွန်းနှင့်ကိုက်ညီသည့်စာတိုက်သင်္ကေတများ၏အသေးစိတ်အချက်အလက်များကိုပြန်ပို့ပေးလိမ့်မည်။
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&zipcode=10005&country=us
တုန့်ပြန်ချက်သည်အောက်ပါအတိုင်းဖြစ်ပါလိမ့်မည် -
{
"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"
}
],
}
}
သငျသညျရလဒ်များကိုအတွက်သင်လိုအပ်သမျှကိုသာရရန်, သင်တောင်းဆိုမှုကို fields
GET https://postalcodes.app/api/v1/?key=YOUR-APIKEY&fields=["range_codes_unique"]&distance=25&zipcode=10005&country=us
တုန့်ပြန်ချက်သည်အောက်ပါအတိုင်းဖြစ်ပါလိမ့်မည် -
{
"query":{
"code": "10005",
"country": "US",
"range": "25",
"measure": ""
},
"results":{
"range_codes_unique": ["07010", "07020", "07022", "07024", "07026", ...]
}
}