公開API（/v1）

eSIM詳細

GET /v1/esims/:id — 検索結果の id で商品1件の詳細と購入リンクを取得します。

このページの内容

リクエスト
パラメータ
レスポンス
エラー

リクエスト#

GET/v1/esims/:id

curl "https://api.esimoa.com/v1/esims/partner_9VKPYQ3JRYVK5797?lang=en" \
  -H "X-API-Key: esk_live_your_key_here"

const id = 'partner_9VKPYQ3JRYVK5797';
const res = await fetch(`https://api.esimoa.com/v1/esims/${encodeURIComponent(id)}?lang=en`, {
  headers: { 'X-API-Key': process.env.ESIMOA_API_KEY },
});
if (res.status === 404) {
  // the plan is no longer on sale — drop it from your listing
}
const { item } = await res.json();

res = requests.get(
    f"https://api.esimoa.com/v1/esims/{esim_id}",
    params={"lang": "en"},
    headers={"X-API-Key": os.environ["ESIMOA_API_KEY"]},
    timeout=10,
)
if res.status_code == 404:
    ...  # the plan is no longer on sale
item = res.json()["item"]

パラメータ#

パラメータ	型	説明
`id`必須	string	パス — 検索結果の id
`lang`	string	レスポンス言語 ko \| en \| ja \| zh-CN \| zh-TW（既定 en）

レスポンス#

item は検索結果の Esim オブジェクトと同じ形です。

200 OKjson

{
  "success": true,
  "item": { "id": "partner_9VKPYQ3JRYVK5797", "title": "Japan · 100 MB · 7 days", "...": "..." }
}

エラー#

存在しない、または販売終了の商品IDは 404 eSIM not found です。保存している商品なら一覧から外してください。

公開API（/v1）

eSIM詳細

GET /v1/esims/:id — 検索結果の id で商品1件の詳細と購入リンクを取得します。

このページの内容

リクエスト
パラメータ
レスポンス
エラー

リクエスト#

GET/v1/esims/:id

curl "https://api.esimoa.com/v1/esims/partner_9VKPYQ3JRYVK5797?lang=en" \
  -H "X-API-Key: esk_live_your_key_here"

const id = 'partner_9VKPYQ3JRYVK5797';
const res = await fetch(`https://api.esimoa.com/v1/esims/${encodeURIComponent(id)}?lang=en`, {
  headers: { 'X-API-Key': process.env.ESIMOA_API_KEY },
});
if (res.status === 404) {
  // the plan is no longer on sale — drop it from your listing
}
const { item } = await res.json();

res = requests.get(
    f"https://api.esimoa.com/v1/esims/{esim_id}",
    params={"lang": "en"},
    headers={"X-API-Key": os.environ["ESIMOA_API_KEY"]},
    timeout=10,
)
if res.status_code == 404:
    ...  # the plan is no longer on sale
item = res.json()["item"]

パラメータ#

パラメータ	型	説明
`id`必須	string	パス — 検索結果の id
`lang`	string	レスポンス言語 ko \| en \| ja \| zh-CN \| zh-TW（既定 en）

レスポンス#

item は検索結果の Esim オブジェクトと同じ形です。

200 OKjson

{
  "success": true,
  "item": { "id": "partner_9VKPYQ3JRYVK5797", "title": "Japan · 100 MB · 7 days", "...": "..." }
}

エラー#

存在しない、または販売終了の商品IDは 404 eSIM not found です。保存している商品なら一覧から外してください。