Airalo Developer Platform
  1. Guides
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
    • Endpoints
      • Orders List
        • Get order list
        • Get order
      • Top-up flow
        • Get eSIMs list
        • Get top-up package list
        • Get eSIM package history
      • Notification
        • Understanding Webhooks: Asynchronous Communication for Modern Applications
        • Airalo Webhooks Optin and Flow
        • Async orders
        • Low data notification - opt In
        • Low data notification - opt out
        • Get low data notification
        • Credit limit notification
        • Webhook definition
        • Webhook simulator
      • Balance
        • Get balance
      • Request access token
      • Get packages
      • Get compatible device list
      • Future Orders
      • eSIM voucher
      • Get eSIM
      • Cancel future orders
      • Submit order
      • Refund Request
      • Get installation instructions
      • Submit order async
      • Get usage (data, text & voice)
      • Submit top-up order
      • Update eSIM brand
    • Guides
      • Step #1 - Authentication
    • Deprecated
      • Authentication
        • Request Access Token
      • Orders
        • Get Order List
        • Get Order
        • Submit Order
        • Submit Top-up Order
      • eSIMs
        • Get eSIMs List
        • Get eSIM
        • Get Installation instructions
        • Get Data Usage
        • Get Top-up Package List
        • Get eSIM Package History
      • Order Statuses
        • Get Order Statuses List
        • Get Order Status Name
      • Packages
        • Get Packages
      • Compatible Devices
        • Get Compatible Device List
      • Notification
        • Low Data Notification
        • Credit Limit Notification
        • Webhook Definition
        • Webhook Simulator
  • SDKs
    • Introduction
    • SDK vs. REST API
    • Technical notes
  • WOOCOMMERCE PLUGIN
    • Introduction
    • Guides
      • How to install the plugin
      • How to setup the Shop price?
      • Customizing "My eSIM" page colors in WooCommerce
      • How to convert prices into local currency
      • How to finalize the shop setup
      • How to test in sandbox
      • How to go live
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
  • SHOPIFY APP
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Guides

eSIM installation methods for API Partners

Airalo Partners offers four flexible approaches for handling eSIM installations, catering to varying levels of control and customization. You can implement these methods via the SDK or Partner API endpoints, depending on your business needs.

1. Create full installation instructions#

Take full control by creating and managing eSIM installation instructions for your users. This option allows you to guide users through the entire process.
Key steps:
1.
Access the QR code:
Retrieve the QR code from the relevant API endpoints (e.g., Submit Order or Get eSIM) or generate the QR code using the activation code and SM-DP+ address.
2.
Provide manual installation instructions:
Share the activation code and SM-DP+ address for manual installation.
3.
Guide network setup:
Include instructions for enabling roaming and configuring the APN (if required).
You are responsible for assisting the user with:
Scanning the QR code or manually entering the activation details.
Configuring the device to ensure proper network functionality.

2. Use multilingual installation instructions#

Leverage Airalo’s multilingual installation instructions to simplify content creation and enhance user experience.
Key steps:
1.
Retrieve details from the Get Installation Instructions:
QR code and installation steps.
Activation code and SM-DP+ address.
Network setup instructions (e.g., roaming, APN configuration).
2.
Display the retrieved information on a partner-hosted webpage.
Advantages:
Reduces development effort.
Supports multiple languages for global accessibility.

3. Share eSIMs Cloud links or PDFs#

Simplify the process with Airalo’s partner-branded or unbranded eSIMs Cloud microsite.
Key steps:
1.
Retrieve the eSIM Cloud sharing link and passcode via the API.
2.
Share the link and passcode through preferred channels, such as email, WhatsApp, or other messaging platforms.
Notes:
Each eSIM has a unique link and passcode.
Users purchasing multiple eSIMs will receive separate links and passcodes.
Common links for multiple eSIMs purchased by the same user are not available.
For details, refer to the Submit order or Submit Order Async endpoints.

4. Partner-branded emails sent by Airalo#

Let Airalo handle end-user communication with partner-branded emails containing installation instructions.
Key features:
Multilingual support.
Emails include the eSIM Cloud link or a PDF with instructions.
Airalo maintains the email content (customization is not available).
Notes:
If custom messaging is required, use method #3 instead.
Each eSIM purchase triggers a separate email.
A copy (bcc) can be requested for your support team to re-send instructions if needed.
For details, refer to the Submit order or Submit order async endpoints.
Previous
How to generate the QR code for an eSIM
Next
Introduction
Built with