Getting Started

Integrate global eSIM provisioning, activation, and data management into your application with the Sotel eSIM API. Supports 180+ countries for seamless data roaming.

Authentication

1. Send your Live API Key to the /authenticate endpoint.
2. Receive a bearer token in the response.
3. Use that token in the Authorization header for all other requests. 

Authorization: Bearer {token}

Base URL

All API requests are made to the following base URL: 

https://api.sotel.com

Rate Limits

The API enforces rate limits to ensure stability. If you exceed the limit, you will receive a 429 Too Many Requests response.

PlanRate LimitBurst
Standard100 requests/min20 requests/sec
EnterpriseContact sales

Error Handling

The API uses standard HTTP status codes. Errors return a JSON body with error and message fields.

CodeMeaningDescription
200OKRequest succeeded.
201CreatedResource created successfully.
400Bad RequestMissing or invalid parameters in the request.
401UnauthorizedInvalid or missing API key.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded. Retry after the indicated period.
500Server ErrorSomething went wrong on our end. Contact support.
Error Response Example
{
  "error": true,
  "message": "Invalid or expired API key."
}

Quick Start

Here's a quick example to create your first eSIM in three steps:

1. Authenticate

Get a bearer token using your Live API Key.

curl -X POST 'https://api.sotel.com/api/esim/authenticate' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_key": "YOUR_LIVE_API_KEY"
  }'

2. Get available countries

List countries with eSIM coverage.

curl -X GET 'https://api.sotel.com/api/esim/countries/all?page=0&size=15' \
  -H 'Authorization: Bearer {token}'

3. Browse data plans

Find available data plans for your target country.

curl -X GET 'https://api.sotel.com/api/esim/data/plan/fetch?country=Nigeria&type=REGION' \
  -H 'Authorization: Bearer {token}'

4. Create an eSIM

Provision a new eSIM with your chosen plan.

curl -X POST 'https://api.sotel.com/api/esim/create' \
  -H 'Authorization: Bearer {token}' \
  -H 'Content-Type: application/json' \
  -d '{
    "productId": "21170179",
    "iso3": "USA"
  }'

API Endpoints

Explore the full API reference by selecting an endpoint from the sidebar, or browse below.