公開 API(/v1)
販售國家
GET /v1/countries — 取得販售 eSIM 的國家及其方案數量與最低價。
請求#
GET
/v1/countriescurl "https://api.esimoa.com/v1/countries?q=japan&lang=en" \
-H "X-API-Key: esk_live_your_key_here"const res = await fetch('https://api.esimoa.com/v1/countries?q=japan&lang=en', {
headers: { 'X-API-Key': process.env.ESIMOA_API_KEY },
});
const { items } = await res.json();res = requests.get(
"https://api.esimoa.com/v1/countries",
params={"q": "japan", "lang": "en"},
headers={"X-API-Key": os.environ["ESIMOA_API_KEY"]},
timeout=10,
)
countries = res.json()["items"]查詢參數#
| 參數 | 類型 | 說明 |
|---|---|---|
q | string | 依國家名稱或代碼搜尋(選填) |
lang | string | 回應語言 ko | en | ja | zh-CN | zh-TW(預設 en) |
q 可比對五種語言中任一種國家名稱(如 japan、일본、日本)。
回應#
200 OKjson
{
"success": true,
"items": [
{
"countryCode": "JP",
"name": "Japan",
"planCount": 128,
"lowestPriceKrw": 1000,
"url": "https://www.esimoa.com/en/plans/jp?ref=p_yourcode"
}
]
}Country 物件#
| 欄位 | 類型 | 說明 |
|---|---|---|
countryCode | string | ISO 3166-1 alpha-2 國家代碼 |
name | string | 國家名稱(依 lang) |
planCount | integer | 販售中的方案數量 |
lowestPriceKrw | integer | null | 最低價(韓元) |
url | string | 國家方案頁面 — 含合作夥伴代碼(?ref=) |
