API publique (/v1)

Obtenir une eSIM

GET /v1/esims/:id — get one eSIM and its purchase link by the id from search results.

On this page

Request
Parameters
Réponse
Errors

Request#

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"]

Parameters#

Paramètre	Type	Description
`id`obligatoire	string	Chemin — l’id issu des résultats de recherche
`lang`	string	Langue de la réponse : ko \| en \| ja \| zh-CN \| zh-TW (en par défaut)

Réponse#

item a la même structure que l’objet Esim des résultats de recherche.

200 OKjson

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

Errors#

Un id inconnu ou abandonné renvoie 404 eSIM not found. Si vous avez enregistré le produit, retirez-le de votre catalogue.