Airalo Developer Platform
  1. Quick start
Airalo Developer Platform
  • OVERVIEW
    • Introduction
    • Attribute descriptions
    • FAQ
    • Quick start
      • Step 1: Request access token
        POST
      • Step 2: Get packages
        GET
      • Step 3: Submit order
        POST
      • Step 4: Get installation instructions
        GET
    • 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. Quick start

Step 1: Request access token

POST
/v2/token
This endpoint comes with a Rate Limit: You can send up to 5 requests to get Access Token during 1 minute.
This endpoint lets you obtain an access token, which is necessary for making requests to the Airalo Partners API. By providing your client ID and client secret, you'll receive a token that is valid for 24 hours.
It's a good idea to store the access token in your API client and request a new one only if the current token expires or becomes invalid.

Request

Header Params

Body Params multipart/form-data

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/token' \
--header 'Accept: application/json' \
--form 'client_id="<replace with client id>";type=string' \
--form 'client_secret="<replace with client secret>"' \
--form 'grant_type="client_credentials"'

Responses

🟢200Request Access Token (200)
application/json
Body

Example
{
    "data": {
        "token_type": "Bearer",
        "expires_in": 31622400,
        "access_token": "<access token>"
    },
    "meta": {
        "message": "success"
    }
}
🟠422Request Access Token (422)
🟠422Request Access Token (401)
Modified at 2025-06-05 13:36:27
Previous
FAQ
Next
Step 2: Get packages
Built with