Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vellosim.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Started with Vellosim API

Follow these simple steps to integrate Vellosim’s eSIM solution into your platform and start offering connectivity services to your customers.

​
Step 1: Get Your API Credentials

  1. Visit vellosim.com and create your merchant account
  2. Complete the verification process
  3. Navigate to your dashboard to access your API credentials
Keep your API key secure and never share it publicly or commit it to version control.
After signing up, you’ll receive:
  • API Key: Your unique authentication token
  • Base URL: https://api.vellosim.com (or your provided endpoint)
Store these credentials securely in your environment variables.

​
Step 2: Make Your First API Call

Test your integration by fetching the list of available eSIM regions:
curl -X GET "https://api.vellosim.com/api/esim/regions" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
This endpoint requires authentication. Make sure to include your API key in the Authorization header.
Retrieve available eSIM packages for a specific region:
curl -X GET "https://api.vellosim.com/api/esim/packages?regionCode=US&regionType=country" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
The response will include package details such as:
  • Package code
  • Data allowance
  • Validity period
  • Pricing
Before making purchases, check your wallet balance:
curl -X GET "https://api.vellosim.com/api/wallet/balance" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"
Ensure you have sufficient balance before attempting to purchase eSIMs.

​
Step 3: Integrate Into Your Platform

Choose your integration path based on your platform:

Website Integration

Step-by-step guide for integrating Vellosim into your web application using JavaScript/TypeScript.

Mobile App Integration

Learn how to integrate eSIM functionality into iOS and Android applications.

​
Next Steps

Now that you have the basics working, explore these features:

Authentication Guide

Learn about authentication best practices and security.

Making Requests

Understand request/response formats and best practices.

Error Handling

Learn how to handle API errors gracefully.

Webhooks

Set up webhooks for real-time order updates.

​
Example: Complete Purchase Flow

Here’s a quick example of a complete eSIM purchase flow: 
// 1. Get available regions
const regions = await fetch('https://api.vellosim.com/api/esim/regions', {
  headers: { 'X-API-Key': `API_KEY}` }
});

// 2. Get packages for a specific region
const packages = await fetch('https://api.vellosim.com/api/esim/packages?regionCode=US&regionType=country', {
  headers: { 'X-API-Key': `API_KEY}` }
});

// 3. Purchase an eSIM
const purchase = await fetch('https://api.vellosim.com/api/esim/buy', {
  method: 'POST',
  headers: {
    'X-API-Key': `API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    packageCode: 'US_1GB_7D',
    paymentMethod: 'wallet',
    packageType: 'data'
  })
});

// 4. Get order details
const order = await purchase.json();
console.log('Order ID:', order.esimId);
Need help? Check our API Reference for detailed documentation or contact support@vellosim.com.