Welcome to Vellosim API
The Vellosim API provides a comprehensive solution for integrating eSIM services into your application or website. Our API enables you to offer global connectivity solutions to your customers with ease.Base URL
Authentication
All API requests require authentication using an API Key in theX-API-Key header.
Production:
Use keys with
vls_live_ prefix for production and vls_test_ prefix for testing/sandbox. The API automatically routes requests to the appropriate environment based on your key prefix.Getting Your API Key
- Log in to your Vellosim dashboard
- Navigate to Developer → API Keys
- Click Generate New API Key
- Copy and securely store your API key
Request Format
Headers
Include these headers in all requests:HTTP Methods
| Method | Usage |
|---|---|
| GET | Retrieve resources (regions, packages, orders) |
| POST | Create resources (purchase eSIMs) |
| PUT | Update resources |
| DELETE | Delete resources |
Response Format
All API responses are returned in JSON format with consistent structure.Success Response
Error Response
Status Codes
| Code | Status | Description |
|---|---|---|
| 200 | OK | Request successful |
| 201 | Created | Resource created successfully |
| 400 | Bad Request | Invalid parameters or business logic error |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | Valid key but insufficient permissions |
| 404 | Not Found | Resource not found |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Server error occurred |
| 503 | Service Unavailable | Service temporarily unavailable |
Rate Limiting
API requests are rate-limited based on your plan:| Plan | Rate Limit |
|---|---|
| Standard | 100 requests/minute |
| Premium | 500 requests/minute |
| Enterprise | Custom limits |
Pagination
Endpoints that return lists support pagination:Pagination Response
API Endpoints
Wallet
Get Balance
Retrieve your current wallet balance
eSIM
Get Regions
Get all available regions (countries & continents)
Get Packages
Get eSIM packages filtered by region
Purchase
Buy eSIM
Purchase an eSIM package
Orders
SDKs and Libraries
We’re working on official SDKs for popular languages. In the meantime, you can use standard HTTP clients like:- JavaScript/TypeScript:
fetch,axios - Python:
requests,httpx - PHP:
cURL,Guzzle - Java/Kotlin:
OkHttp,Retrofit - Swift:
URLSession,Alamofire
Support
Need help integrating the API?- 📚 Check our guides for step-by-step tutorials
- 💬 Contact support at [email protected]
- 🌐 Visit vellosim.com for more information
