Quickstart

This gets you from zero to a provisioned test eSIM in under five minutes. Everything here runs against the sandbox on a mock network — no real spend, no Vodafone, no NDA.

1. Get a sandbox key.

   Grab a free sandbox key from the signup page. It looks like ig_test_… and only ever touches the sandbox. Export it:

   export IG_KEY="ig_test_your_key_here"

2. Make your first call.

   Confirm the key works and see who you are. The sandbox base URL is https://api.sandbox.interglobe.io/v1.

   curl

   curl https://api.sandbox.interglobe.io/v1/me \
     -H "Authorization: Bearer $IG_KEY"

   TypeScript

   import { InterGlobe } from "@interglobe/sdk";
   
   const ig = new InterGlobe({ apiKey: process.env.IG_KEY! });
   console.log(await ig.me());

3. Provision a test eSIM.

   Pick a product from the catalog, then provision. Provisioning is asynchronous — you get an execution id back and an esim.provisioned webhook when it’s ready.

   curl

   # List available sandbox products
   curl https://api.sandbox.interglobe.io/v1/products \
     -H "Authorization: Bearer $IG_KEY"
   
   # Provision one (async saga → returns 202 + an execution id)
   curl -X POST https://api.sandbox.interglobe.io/v1/esims \
     -H "Authorization: Bearer $IG_KEY" \
     -H "Content-Type: application/json" \
     -H "Idempotency-Key: $(uuidgen)" \
     -d '{ "product_id": "prod_eu_5gb" }'

   TypeScript

   const products = await ig.products.list();
   const esim = await ig.esims.provision({ product_id: products.data[0].id });
   console.log(esim); // 202 → execution_id; watch for the esim.provisioned webhook

4. Get the install (QR).

   Once provisioned, fetch the install profile — the LPA string / QR your end user scans to install the eSIM.

   curl https://api.sandbox.interglobe.io/v1/esims/{iccid}/install \
     -H "Authorization: Bearer $IG_KEY"

That's the whole loop

You just provisioned connectivity end‑to‑end without talking to a human. The same code targets production — swap your ig_test_ key for an ig_live_ key and the base URL to https://api.interglobe.io/v1.

Next steps

• Explore every endpoint in the API Reference (with a live “try it” console).
• Set up signed webhooks to receive esim.* and bundle.* events.
• Drive test scenarios — deplete a bundle, fail an activation, fast‑forward expiry.