Using the API
Start working with our eSIM API.
Last updated
Was this helpful?
Start working with our eSIM API.
Last updated
Was this helpful?
To get started using the API:
View and / or
Agree to the
Fund your account and purchase an eSIM
After login, you will be in the sandbox testing area, with test credit and eSIMs. With in the sandbox account you can:
Make a deposit of funds
Navigate to Billing > Make External Deposit
Make a eSIM purchase
Go to Products and choose one of the available choices
Go to Purchases and review purchase history
Generate your API Key
Make API calls
Calling the sandbox API is done with the follwing endpoint:
Once satisfied with your process, you can switch to the live environment. You can use the same API or roll a new one. The API key is the same for both Sandbox and Live enviroments.
In the live environment use the following endpoint:
Purchasing an eSIM is possible once you have a positive account balance. When requesting the eSIM, your balance is deducted according to your current monthy tier.
When purchasing via API, you will receive a JSON eSIM payload. This provides both the manual entry data as well as the QR code for adding an eSIM.
Parameters
Description
manual1
String for manual entry of SM-DP+ Address
manual2
Sring for Activation Code
optionalCode
Confirmation Code. Used with some eSIM providers
phone
eSIM phone number
serial
eSIM Serial number
expiryDate
eSIM expiry date
qrCodeString
QR code payload string. Populate your custome QR code with this data.
qrCodeDataUrl
QR code PNG imag
GET
https://app.dataplans.io/api/v1/plan/{slug}
Fetch plan details with slug
slug
string
Sample value:sim2fly-asia
Additionally, you can interact with the with your API Key. Click the Authorize button and enter your API key to work with the API within the Swagger doc.
You can interact with the with your API Key.
Postman is a great way to work with our API and you can into your project.