Airalo Developer Platform
  1. REST API
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
      • Step 2: Get packages
      • Step 3: Submit order
      • Step 4: Get installation instructions
    • User journeys
      • Purchase journey
      • Top-up journey
    • Guides
      • How to set up a brand for eSIMs Cloud link sharing
      • How to get the eSIMs Cloud sharing link through API
      • How to generate the QR code for an eSIM
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Rate limits
    • Error handling
    • Go live checklist
    • Endpoints
      • Authenticate
        • Request access token
      • Browse packages
        • Get packages
      • Place order
        • Submit order
        • Submit order async
        • Future orders
        • eSIM voucher
      • Install eSIM
        • Get eSIM
        • Get installation instructions
      • Monitor usage
        • Get usage (data, text & voice)
      • Place top up order
        • Submit top-up order
        • Get top-up package list
        • Get eSIMs list
        • Get eSIM package history
      • Manage orders & eSIMs
        • Get order list
        • Cancel future orders
        • Get order
        • Update eSIM brand
        • Future Orders
      • Compatible devices
        • [Deprecated] Get compatible device list
        • Get compatible device lite list
      • Notifications
        • Airalo webhooks opt-in and flow
        • Webhooks guide
        • Webhook definition
        • Notification: Low data
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Credit limit
          • Opt in
          • Get notification details
          • Opt out
        • Notification: Async orders
          • Opt in
          • Get notification details
          • Opt out
        • Webhook simulator
      • Check balance
        • Get balance
      • Request refund
        • Request refund
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the Airalo Plugin for WooCommerce
      • How to customize the "My eSIMs" page colors in WooCommerce
      • How to convert prices into your local currency
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. REST API

Go live checklist

Partner journey summary#

1.
Apply to become a partner. You'll be connected with a dedicated account manager.
2.
Your account manager will review your application and guide you through initial discussions.
3.
Legal and contractual requirements are verified and confirmed.
4.
Your company will be set up in our system as an API partner, with Sandbox mode enabled.
5.
Log in to the Partner Platform and collect your API credentials.
6.
Begin your integration using our REST API, SDKs, or eCommerce plugins.
7.
Test all features thoroughly in Sandbox mode.
8.
Review and complete the Go Live Checklist.
9.
Contact your account manager to switch your account to Production (Live) mode.

Go live checklist#

Before switching to Production (Live) mode, make sure you’ve covered the following:
Remember: Sandbox mode and Production mode use the same API URL — no changes needed.
Test all endpoints in Sandbox mode, including creating, topping up, and checking balances.
Follow the Quick Start Guide for a full order flow:
Get Auth
Get Packages
Submit Order
Get installation Instructions
Get eSIM
Get Usage
Test the top-up flow:
Get Auth
Get Topup Package List
Submit Topup Order
Get Usage
Test webhooks notifications:
Opt-in/Opt-out flow
Validate receiving payloads on your server
Review API errors and ensure your system handles them properly.
Confirm that your system is ready to handle live orders.
Ensure you have monitoring/logging in place to track any API errors in Production.
Confirm expected responses for:
Out-of-stock eSIMs
Invalid package names
Invalid ICCIDs
Remember: Implement and test automatic package updates via GET Packages, every 60 minutes.
Familiarize yourself with the filter parameter in the GET Packages endpoint (filter by countries, types) and the include parameter.
Let your account manager know once all flows have been successfully tested in Sandbox mode and you are ready to switch to Production mode.
Remember: Once switched to Production mode, you cannot return to Sandbox!
If you need to extend functionality in the future, reach out to your account manager to create a new test company for you.
Modified at 2025-09-04 14:28:20
Previous
Error handling
Next
Endpoints
Built with