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

# Quickstart

> Start integrating Vellosim eSIM API in minutes

## Get Started with Vellosim API

Follow these simple steps to integrate Vellosim's eSIM solution into your platform and start offering connectivity services to your customers.

### Step 1: Get Your API Credentials

<AccordionGroup>
  <Accordion icon="user-plus" title="Sign up for an account">
    1. Visit [vellosim.com](https://vellosim.com) and create your merchant account
    2. Complete the verification process
    3. Navigate to your dashboard to access your API credentials

    <Tip>Keep your API key secure and never share it publicly or commit it to version control.</Tip>
  </Accordion>

  <Accordion icon="key" title="Retrieve your API key">
    After signing up, you'll receive:

    * **API Key**: Your unique authentication token
    * **Base URL**: `https://api.vellosim.com` (or your provided endpoint)

    Store these credentials securely in your environment variables.
  </Accordion>
</AccordionGroup>

### Step 2: Make Your First API Call

<AccordionGroup>
  <Accordion icon="earth-americas" title="Fetch available regions">
    Test your integration by fetching the list of available eSIM regions:

    ```bash theme={null}
    curl -X GET "https://api.vellosim.com/api/esim/regions" \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"
    ```

    <Tip>This endpoint requires authentication. Make sure to include your API key in the Authorization header.</Tip>
  </Accordion>

  <Accordion icon="box" title="Get eSIM packages">
    Retrieve available eSIM packages for a specific region:

    ```bash theme={null}
    curl -X GET "https://api.vellosim.com/api/esim/packages?regionCode=US&regionType=country" \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"
    ```

    The response will include package details such as:

    * Package code
    * Data allowance
    * Validity period
    * Pricing
  </Accordion>

  <Accordion icon="wallet" title="Check wallet balance">
    Before making purchases, check your wallet balance:

    ```bash theme={null}
    curl -X GET "https://api.vellosim.com/api/wallet/balance" \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"
    ```

    <Note>Ensure you have sufficient balance before attempting to purchase eSIMs.</Note>
  </Accordion>
</AccordionGroup>

### Step 3: Integrate Into Your Platform

Choose your integration path based on your platform:

<CardGroup cols={2}>
  <Card title="Website Integration" icon="browser" href="/guides/website-integration">
    Step-by-step guide for integrating Vellosim into your web application using JavaScript/TypeScript.
  </Card>

  <Card title="Mobile App Integration" icon="mobile" href="/guides/mobile-app-integration">
    Learn how to integrate eSIM functionality into iOS and Android applications.
  </Card>
</CardGroup>

## Next Steps

Now that you have the basics working, explore these features:

<CardGroup cols={2}>
  <Card title="Authentication Guide" icon="shield-halved" href="/guides/authentication">
    Learn about authentication best practices and security.
  </Card>

  <Card title="Making Requests" icon="paper-plane" href="/guides/making-requests">
    Understand request/response formats and best practices.
  </Card>

  <Card title="Error Handling" icon="triangle-exclamation" href="/guides/error-handling">
    Learn how to handle API errors gracefully.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/guides/webhooks">
    Set up webhooks for real-time order updates.
  </Card>
</CardGroup>

## Example: Complete Purchase Flow

Here's a quick example of a complete eSIM purchase flow:

```javascript theme={null}
// 1. Get available regions
const regions = await fetch('https://api.vellosim.com/api/esim/regions', {
  headers: { 'X-API-Key': `API_KEY}` }
});

// 2. Get packages for a specific region
const packages = await fetch('https://api.vellosim.com/api/esim/packages?regionCode=US&regionType=country', {
  headers: { 'X-API-Key': `API_KEY}` }
});

// 3. Purchase an eSIM
const purchase = await fetch('https://api.vellosim.com/api/esim/buy', {
  method: 'POST',
  headers: {
    'X-API-Key': `API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    packageCode: 'US_1GB_7D',
    paymentMethod: 'wallet',
    packageType: 'data'
  })
});

// 4. Get order details
const order = await purchase.json();
console.log('Order ID:', order.esimId);
```

<Note>
  **Need help?** Check our [API Reference](/api-reference/introduction) for detailed documentation or contact [support@vellosim.com](mailto:support@vellosim.com).
</Note>