Overview

Welcome to the eSimply B2B Partner API. This API empowers enterprise partners including travel agencies, airlines, OTAs, and fintech platforms to seamlessly embed global connectivity products directly into their own applications. By integrating our API, you can query available destinations, display tailored data packages to your users, and provision eSIMs in real-time, all while retaining full control over your customer experience and retail margins.

The Integration Flow

sequenceDiagram
    autonumber
    actor User as End-User
    participant Partner as Partner Backend
    participant API as eSimply API

    %% Discovery
    rect rgb(244, 246, 255)
    Note right of User: 1. Discovery
    User->>Partner: Selects Destination (e.g., "France")
    Partner->>API: GET /esim/destination/FR/packages
    API-->>Partner: Returns Packages & B2B Pricing
    Partner-->>User: Displays Data Plans (Retail Price)
    end

    %% Reservation
    rect rgb(255, 250, 240)
    Note right of User: 2. Reservation
    User->>Partner: Selects Plan & Travel Date
    Partner->>API: POST /orders/cart (package_id, start_date)
    API-->>Partner: Returns cart_key
    end

    %% Execution
    rect rgb(240, 255, 240)
    Note right of User: 3. Execution (Provisioning)
    User->>Partner: Completes Payment on your app
    Partner->>API: POST /orders/submit (cart_key, User Details)
    Note over API: Deducts cost from Partner Wallet<br/>Mints eSIM with Carrier
    API-->>Partner: ICCID, QR Code, SM-DP+ Address
    Partner-->>User: Displays eSIM Installation UI
    end

Key Features

• Global Package Catalog: Access a vast inventory of eSIM packages across 190+ destinations, with data sizes and validity periods optimized for global travelers.
• Flexible Ordering System: Streamlined, cart-based ordering with customizable start_date parameters, allowing your customers to plan their connectivity needs months in advance.
• Prepaid Balance Management: Operate on a unified prepaid partner balance. Transactions are settled instantly upon order submission, giving you real-time control and visibility over your inventory costs.
• Automated Activation: Deliver instant connectivity. Mints return standard LPA strings (QR codes) and activation codes for seamless zero-touch or manual provisioning.

Environments

eSimply provides two strictly isolated environments to support a safe, predictable integration lifecycle:

Environment	Base URL	Purpose
Sandbox	https://api-sandbox.esimply.io	Development & testing
Production	https://api.esimply.io	Live traffic

Never use your production API key in development or testing. The two environments use separate API keys and are completely independent.