VRIL Node SDK & Developer Guide

The SDK automatically reads ESIMACCESS_ACCESS_CODE and ESIMACCESS_SECRET_KEY from environment variables, rotating tokens transparently.

import { EsimAccessService } from '@/lib/esimaccess';

// Client consumes environment credentials by default
const client = EsimAccessService;

// Verify connection and credit balance
const balance = await client.queryBalance();
console.log('Balance USD:', balance.data?.balance);

Query cached and real-time packages with ISO-3166-1 alpha-2 country codes.

// Fetch available cellular packages for Japan (JP)
const response = await client.getPackages({
  locationCode: 'JP',
  type: 'local',
});

const packages = response.data.packageList;
for (const plan of packages) {
  console.log(`${plan.packageCode}: ${plan.dataMb / 1024}GB for ${plan.durationDays}d - $${plan.price}`);
}

Triggers carrier provisioning pipeline and returns LPA string and QR code asset.

// Provision an eSIM order
const order = await client.createOrder({
  packageCode: 'JP_10GB_30D',
  price: 12.00,
  transactionId: `ORD-${Date.now()}`,
});

console.log('Order status:', order.orderNo, order.status);
// orderNo: "ORD-2026-84920"
// status: "processing" | "completed"

Inspect cellular consumption, active session timestamps, and remaining bytes directly from Tier-1 carrier networks.

// Query telemetry for active ICCID
const usage = await client.getSimUsage('89814400000072184931');

console.log('Total MB:', usage.totalDataMb);
console.log('Used MB:', usage.usedDataMb);
console.log('Remaining MB:', usage.remainingDataMb);
console.log('Expires:', usage.expiresAt);