Skip to main content

​
Overview

Endpoints enable eSIM order creation through HMAC-SHA256 signature-based authentication. Requires partner access key and secret key credentials.

​
Authentication

Endpoints use HMAC-SHA256 signature-based authentication. You’ll need:
  • Access Key: Partner access key
  • Secret Key: Partner secret key (Base64 encoded)
See the Authentication guide for detailed authentication instructions.

​
Base URL

All requests should be made to: Production: 
https://api.esimstory.com/api
Sandbox: 
https://sandbox-api.esimstory.com/api
Endpoints are relative to the base URL. For example, to create an order, use POST /v1/api_partner/orders.

​
Request Format

All requests must:
  • Use application/json content type
  • Include required authentication headers
  • Include a valid timestamp (within 5 minutes)
  • Include a valid HMAC signature

​
Response Format

All responses are returned in JSON format with snake_case field names.

​
Rate Limits

Endpoints are subject to rate limiting. Contact support for your specific rate limits.

​
Sandbox Environment

The API supports both sandbox and production environments. In sandbox mode, orders are processed using test data and do not result in actual eSIM purchases.

​
Webhooks

After creating an order, eSIM data will be delivered to your configured webhook URL once ready. Each order item receives a separate webhook call with the eSIM activation data. Important: You must configure a webhook URL in your partner settings to receive eSIM data. See the Create Order endpoint documentation for detailed webhook payload structure and handling.

Create Order

Create eSIM orders via API

Authentication

Learn how to authenticate your requests
Last modified on January 29, 2026