> ## Documentation Index
> Fetch the complete documentation index at: https://developers.mioesim.com/llms.txt
> Use this file to discover all available pages before exploring further.

# MIOeSIM API: eSIM & SIM card ordering platform

> MIOeSIM gives you a REST API to browse, order, and manage eSIM and physical SIM card plans across 125+ countries. Integrate connectivity into your platform.

The MIOeSIM API lets you build connectivity features directly into your platform. Browse a global catalog of eSIM and physical SIM card plans, place orders programmatically, deliver QR codes to your customers, and manage the full lifecycle — renewals, cancellations, usage queries — all via HTTP.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="bolt" href="/quickstart">
    Make your first API call in minutes. Authenticate, browse plans, and place an order.
  </Card>

  <Card title="Authentication" icon="lock" href="/authentication">
    Learn how to obtain a token and sign every request with the HMAC-MD5 signature scheme.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/login">
    Full endpoint documentation with request parameters, response schemas, and examples.
  </Card>

  <Card title="Core Concepts" icon="book" href="/concepts/skus-and-packages">
    Understand SKUs, packages, orders, and ICCID — the key building blocks of the MIOeSIM API.
  </Card>
</CardGroup>

## How it works

<Steps>
  <Step title="Authenticate">
    Call `POST /api_order/login` with your phone number and password to receive a session token. All subsequent requests require this token plus a request signature.
  </Step>

  <Step title="Browse the catalog">
    Call `GET /api_esim/getSkus` to list available eSIM products, then `GET /api_esim/getPackages` to see the data plans and pricing for a specific product (SKU).
  </Step>

  <Step title="Place an order">
    Call `POST /api_esim/addEsimOrder` with the SKU ID, price ID, and quantity. The response includes the activation code, QR code data, and ICCID for each eSIM.
  </Step>

  <Step title="Manage the lifecycle">
    Renew plans, cancel orders, query usage, and resend QR code PDFs to customers — all through the API.
  </Step>
</Steps>

## Explore by topic

<CardGroup cols={3}>
  <Card title="SKUs & Packages" icon="sim-card" href="/concepts/skus-and-packages">
    Products, data plans, pricing, and supported countries.
  </Card>

  <Card title="Orders" icon="bag-shopping" href="/concepts/orders">
    Placing, querying, renewing, and cancelling orders.
  </Card>

  <Card title="ICCID & Cards" icon="credit-card" href="/concepts/iccid-and-cards">
    Card identifiers, usage data, and card status.
  </Card>

  <Card title="Java Example" icon="java" href="/examples/java">
    Full login and signing demo in Java.
  </Card>

  <Card title="PHP Example" icon="php" href="/examples/php">
    Full login and signing demo in PHP.
  </Card>

  <Card title="Python Example" icon="python" href="/examples/python">
    Full login and signing demo in Python.
  </Card>
</CardGroup>

<Note>
  Need help? Contact support at [help@mioesim.com](mailto:help@mioesim.com).
</Note>