Airalo Developer Platform
  1. Guides
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Partner with Airalo
    • Attribute descriptions
    • FAQ
    • 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
      • How to share eSIM installation instructions with users
      • eSIM installation methods for API Partners
  • REST API
    • Introduction
    • Product updates
    • Rate limits
    • Error handling
    • Guides
      • Step #1 - Authentication
    • Quick start
      • Request access token
      • Get packages
      • Submit order
      • Get installation instructions
    • 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 compatible device list
      • Get packages
      • Submit order
      • Submit order async
      • Submit top-up order
      • Get eSIM
      • Get data usage
      • Get installation instructions
      • Update eSIM brand
      • eSIM voucher
      • Refund Request
      • Future Orders
      • Cancel future orders
    • 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
    • Product updates
    • 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
      • TO DELETE Installation plugin backup
      • Customizing WooCommerce email templates for eSIM sales
    • Troubleshooting
      • Troubleshooting
  • SHOPIFY INTEGRATION
    • Introduction
    • Guides
      • How to install the Airalo Shopify App
      • How to set up prices in Shopify
  1. Guides

How to set up a brand for eSIMs Cloud link sharing

We’ve enabled custom branding to highlight your own brand while sharing eSIMs. This can be set up by creating a brand in the Partner Platform. The brand settings play a crucial role in customizing the experience across various components of eSIMs, the Partner Platform, emails, and PDFs. Here's how they are used in each area:
eSIMs Cloud: Brand settings personalize the eSIM details display, incorporating logos and colors in the user interface. This ensures consistent brand representation when customers interact with the eSIM service.
Partner Platform: Brand settings customize eSIM QR codes, reflecting your own brand by showcasing your logo.
eSIM emails: Brand settings influence the appearance of emails sent to customers. They ensure that email templates carry your branding (logo, colors, etc.) and contain the eSIMs Cloud link, creating a consistent look and feel in communications.
eSIM PDFs: Brand settings apply to generated PDF documents, incorporating logos and support contact details.

How do I access brand settings?#

Once you have the necessary permissions, you can access the Brand Settings page. Click on your username in the top right corner. The Company Settings will contain a Brand Settings tab.
Screenshot 2024-11-23 at 23.24.57.png

How do I create a new brand?#

Enter the brand name. The system will automatically suggest a unique brand alias, with a validation check to ensure it’s not already in use.
You’ll also see the eSIMs Cloud URL and email associated with the brand.
The brand setting name serves as an internal identifier for brand settings within the system. This parameter will be used to assign a brand via the API.
Screenshot 2024-11-23 at 23.25.38.png
Add the visual elements for brand styling, including your brand logo, icon, hero image, and brand color.
Screenshot 2024-11-23 at 23.26.15.png
In the Customer Support Details section, include your support email and optional phone number.
Brand eSIM settings allow you to manage the visibility of eSIM details. Once it’s:
Enabled - users can check the eSIM usage and details.
Disabled - only the installation instructions are visible, with basic eSIM Information.
As you change these settings, the preview section updates in real-time, previewing the branded PDF and other changes.

What do the brand settings affect?#

Based on the brand settings, other parts of our products can be affected. The table below shares the details of those connections.
InputAffects →QR CodeeSIM PDFeSIMs CloudShare eSIM Emails
Brand nameN/AN/AName of the Web TabSender name
Brand aliasN/AN/AURL → https://esims.cloud/{brand_alias}/{eSIM_id}Sender email → {brand_alias}@esims.cloud
Brand setting nameN/AN/AN/AN/A
Brand logoN/AIt’s visible on the top of the PDFVisible on the top of the PageN/A
Brand iconVisible in the center of the QR CodeVisible in the QR codesVisible in the Browser’s Tab Favicon Visible in QR CodesN/A
Hero imageN/AN/AVisible in Contact us PageVisible on the top of a Branded Email

Once the brand is created, how do I assign the brand through API?#

When submitting an order, the brand can be specified by adding the "brand_settings_name" value. It also can be done at a later stage by updating the assigned brand. This ensures that the eSIM will reflect the selected brand’s settings, such as logos and color schemes.
All the details about retrieving branded eSIM information are outlined in How to get the eSIMs Cloud sharing link through API.

Can I use the eSIM sharing link without creating a brand?#

Yes, you can. If neither method is used to specify branding, the eSIM will be unbranded by default. This means it won’t include any partner-specific branding for sharing, and users won’t see Contact Us details. All of the other functionalities will still work.
Modified at 2025-01-13 17:40:18
Previous
Top-up journey
Next
How to get the eSIMs Cloud sharing link through API
Built with