Docs
Platform API Documentation
Platform API Documentation
Complete API reference for eSIM integration
Platform API Documentation
Welcome to the Platform API documentation. This guide provides everything you need to integrate eSIM services into your application.
Quick Start
- Get your API credentials - Contact Platform to obtain your
RT-AccessCode - Explore available packages - Use the Data Packages endpoint
- Order eSIM profiles - Create orders via the Order Profiles endpoint
- Set up webhooks - Receive real-time notifications with Webhooks
API Endpoints
| Endpoint | Description |
|---|---|
| Data Packages | Get available eSIM packages |
| Order Profiles | Order new eSIM profiles |
| Query Profiles | Query allocated profiles |
| Profile Management | Cancel, suspend, unsuspend, revoke profiles |
| Balance Query | Check your account balance |
| Top Up | Top up existing eSIMs |
| Webhooks | Configure webhook notifications |
| Send SMS | Send SMS to eSIM profiles |
| Usage Check | Check data usage |
| Supported Regions | Get supported countries and regions |
Authentication
All API requests require the RT-AccessCode header:
curl --location --request POST 'https://your-api-domain.com/api/v1/open/...' \
--header 'RT-AccessCode: YOUR_ACCESS_CODE' \
--header 'Content-Type: application/json'Base URL
https://your-api-domain.com/api/v1/open
Need Help?
- View the API Overview for detailed authentication and error handling
- Contact support for API credentials and technical assistance