Airalo Developer Platform
  1. SDKs
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. SDKs

Introduction

Introduction#

A Software Development Kit (SDK) is a comprehensive set of tools, libraries, documentation, and sample code that helps developers build applications for a specific platform or service while incorporating best practices for efficient development and integration, allowing developers to focus on innovation and enhancing the user experience.
Our SDK is designed for seamless integration with Airalo's B2B Partner API, currently supporting PHP and Node.js, with Python and more languages coming soon.

Getting started#

PHP
Node.js
Python
The Airalo PHP SDK provides an easy way to interact with Airalo's services using PHP.
GitHub Repository: Airalo PHP SDK
Installation:
composer require airalo/sdk

Advantages of using the SDK#

Streamlined integration#

Ease of use: The SDK abstracts the complexities of interacting with the Airalo Partner API by providing pre-built functions and methods for essential tasks such as authentication, data retrieval, and error handling.
Accelerated development: By leveraging the SDK, developers can quickly integrate core API functionalities without spending time on boilerplate code, significantly reducing development effort and time-to-market.

Enhanced security#

Integrated security features: The SDK includes automatic authentication and encryption mechanisms, ensuring secure communication with the Airalo Partner API. These built-in safeguards minimize the risk of vulnerabilities arising from improper handling of sensitive data.

Optimized performance#

Caching and rate limiting: The SDK manages caching and rate limiting internally, optimizing performance by reducing redundant API calls and efficiently handling API usage limits. This results in improved response times and a smoother user experience.
Efficient data handling: Features such as automatic pagination and bulk operations enable efficient data retrieval and manipulation, simplifying workflows when working with large datasets or performing multiple actions in a single request.
Consistent and unified responses: The SDK standardizes API responses, improving data consistency and enhancing code readability.

Comprehensive support and documentation#

Extensive documentation: The SDK is accompanied by detailed documentation, including method descriptions and practical examples, enabling developers to seamlessly integrate it into their projects.
Sample code: Pre-built code snippets illustrate common use cases, guiding developers through the integration process and reducing the learning curve.
Previous
Webhook Simulator
Next
SDK vs. REST API
Built with