In this video, I show you how to make your first API plan purchase using Postman. If you didn’t get your eSIM API set up yet, you can go watch that step now.
Perquisites
Before you get started, make sure you have a free Postman account, eSIM Access account and have funded your account with enough for a purchase.
Follow these steps to make your first API purchase
Lets go thru the steps to make a purchase.
- Run the Merchant Balance end point to verify you have funds in your account.
- With a positive balance, view all the current packages, and find one to purchase.
- Copy the packageCode and the price
- In the Order Profile endpoint, paste your chosen package code in the JSON body of the request.
- Next, paste the price value in both price and amount. (Divide by 10,000 to get the USD price for reference.)
- Enter any value in transactionId. This value is generated by you, and should be unique for each unique order.
- Send your query.
- If successful, you will receive an order number.
- With your order number, next go to Query all Allocated Profiles to request the eSIM payload for your order number
- In the body of your JSON request add the value of your order number to the orderNo parameter
- Send your query.
- Your response will give the eSIM details, used to add to a device.
Setup steps in more detail
Begin by running the Get Merchant Balance endpoint to ascertain the funds in your account. This API call fetches the available balance from your merchant account. Ensuring that your account has sufficient funds before making a purchase is critical to prevent transaction failures.
Once you’ve verified a positive balance, you can proceed to view all the current eSIM packages available for purchase. These packages can be viewed using a specific endpoint, possibly named something like Get All Packages. Browse through the available packages to select the one that best suits your needs.
After choosing your preferred package, copy the packageCode and price associated with it. The packageCode is a unique identifier for each package, and the price indicates the cost of purchasing that particular package. Keep these details handy as you’ll need them in the subsequent steps.
Navigate to the Order Profile endpoint to initiate your purchase. In the JSON body of your API request, paste the packageCode of the package you chose earlier. The JSON body is a part of your API request where you provide specific details about your request.
Now paste the price value into two fields: ‘price‘ and ‘amount‘. The ‘price‘ field is used to identify the cost of the package, while the ‘amount’ field is the total cost of the transaction in case of a batch order. For reference, divide the price by 10,000 to get the USD equivalent.
Enter a unique value in the transactionId field. The transactionId is an identifier that you generate for each unique order. It helps in tracking and managing individual transactions and should be unique for every new order you place.
Once you’ve filled in all the necessary fields, send your API request by clicking ‘Send‘ in Postman. This will initiate the transaction process and send your order request to the eSIM service.
If the transaction is successful, the response from the API will include an ‘order number‘. This is a unique ID for your specific purchase and is needed for retrieving the eSIM payload in the next steps. Make sure to save this order number for the next step.
Now that you have your order number, go to the Query all Allocated Profiles endpoint. This API call is used to request the eSIM payload associated with your order number. The eSIM payload is the digital equivalent of a physical SIM and is what you’ll load onto your device to access the eSIM service.
In the JSON body of your request to Query all Allocated Profiles, add the value of your ‘order number‘ to the ‘orderNo‘ parameter. This will specify the particular order for which you’re requesting the eSIM payload.
Once you’ve entered the necessary details, send your API request.
The API response will contain the eSIM details, including the eSIM profile and other relevant information. This payload can now be added to your device following the specific device instructions. Once loaded, the eSIM will allow your device to access the network services associated with the package you purchased.
