Справочник Partner API

Все эндпоинты возвращают JSON. Вы никогда не отправляете цену - вы только указываете, что хотите купить, а цену всегда рассчитывает сам сервер, поэтому её нельзя подделать или изменить.

Базовый URL:

Base URL
https://buyukesim.com/api/v1

Аутентификация

Отправляйте ваш API-ключ как Bearer токен в каждом из следующих запросов.

Примечание: пополнение баланса - это действие только на сайте (через ваш Magic Code панели), а не часть этого API - ваш API-ключ не может создавать или финансировать пополнения.

Header
Authorization: Bearer buk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Товары

GET/api/v1/products

Список товаров

Получите продукт UK номера и все активные пакеты Travel eSIM (с актуальным package_code и price_usd), чтобы всегда знать, что доступно для покупки перед вызовом Создать заказ.

Request
curl "https://buyukesim.com/api/v1/products" \
  -H "Authorization: Bearer buk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Response
{
  "success": true,
  "data": {
    "discount_pct": 15,
    "uk_number": {
      "type": "uk_number",
      "retail_price_usd": 25,
      "price_usd": 21.25,
      "currency": "USD",
      "min_quantity": 1,
      "max_quantity": 10
    },
    "travel_data": [
      {
        "package_code": "GB_1GB_7D",
        "name": "United Kingdom 1GB / 7 Days",
        "location_code": "GB",
        "retail_price_usd": 5.99,
        "price_usd": 5.09,
        "volume_label": "1 GB",
        "duration": 7,
        "duration_unit": "DAY"
      }
    ]
  }
}

Заказы

POST/api/v1/orders

Создать заказ - UK номер

Создаёт и мгновенно обрабатывает заказ UK номера (+44), списываемый с вашего предоплаченного баланса.

Request
curl -X POST "https://buyukesim.com/api/v1/orders" \
  -H "Authorization: Bearer buk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
  "product_type": "uk_number",
  "quantity": 1,
  "reference": "order-1234"
}'
Response
{
  "success": true,
  "data": {
    "order_id": 98421,
    "reference": "order-1234",
    "status": "paid",
    "product": {
      "type": "uk_number",
      "quantity": 1,
      "retail_price_usd": 25,
      "discount_pct": 15,
      "price_usd": 21.25
    },
    "lookup_code": "K7M9-2XP4",
    "created_at": "2026-07-06T20:00:00+00:00"
  }
}
POST/api/v1/orders

Создать заказ - Travel eSIM

Создаёт и мгновенно обрабатывает заказ Travel eSIM для указанного package_code.

Request
curl -X POST "https://buyukesim.com/api/v1/orders" \
  -H "Authorization: Bearer buk_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
  "product_type": "travel_data",
  "package_code": "GB_1GB_7D",
  "reference": "order-1235"
}'
Response
{
  "success": true,
  "data": {
    "order_id": 98422,
    "reference": "order-1235",
    "status": "paid",
    "product": {
      "type": "travel_data",
      "package_code": "GB_1GB_7D",
      "package_name": "United Kingdom 1GB / 7 Days",
      "location_code": "GB",
      "retail_price_usd": 5.99,
      "discount_pct": 15,
      "price_usd": 5.09
    },
    "lookup_code": null,
    "created_at": "2026-07-06T20:00:00+00:00"
  }
}
GET/api/v1/orders/98421

Статус заказа

Проверьте статус и получите детали QR/PUK для созданного вами заказа.

Request
curl "https://buyukesim.com/api/v1/orders/98421" \
  -H "Authorization: Bearer buk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Response
{
  "success": true,
  "data": {
    "order_id": 98421,
    "reference": "order-1234",
    "status": "paid",
    "product": { "type": "uk_number", "quantity": 1, "retail_price_usd": 25, "price_usd": 21.25 },
    "lookup_code": "K7M9-2XP4",
    "esim": {
      "ready": true,
      "items": [
        { "qr_code": "https://.../serve_qr.php?...", "iccid": "8944...", "puk_code": "12345678" }
      ]
    }
  }
}
GET/api/v1/orders/98422/usage

Использование данных Travel eSIM

Актуальные остаток/использованные данные, статус активации и срок действия заказа Travel eSIM, получаемые напрямую от провайдера при каждом запросе.

Request
curl "https://buyukesim.com/api/v1/orders/98422/usage" \
  -H "Authorization: Bearer buk_live_xxxxxxxxxxxxxxxxxxxxxxxx"
Response
{
  "success": true,
  "data": {
    "order_id": 98422,
    "status": "paid",
    "package": {
      "package_code": "GB_1GB_7D",
      "name": "United Kingdom 1GB / 7 Days",
      "location_code": "GB",
      "volume_label": "1 GB",
      "duration": 7,
      "duration_unit": "DAY"
    },
    "usage": {
      "iccid": "8944...",
      "esim_status": "IN_USE",
      "smdp_status": "ENABLED",
      "total_volume_bytes": 1073741824,
      "used_volume_bytes": 214748364,
      "remaining_volume_bytes": 858993459,
      "usage_percent": 20.0,
      "total_duration": 7,
      "duration_unit": "DAY",
      "expired_time": "2026-07-13T20:00:00+00:00"
    }
  }
}

Коды ошибок

Каждый ответ с ошибкой имеет одинаковую структуру: success: false на верхнем уровне и объект error со стабильным полем code, которое ваш код может проверить, чтобы точно понять, что произошло.

Error shape
{
  "success": false,
  "error": { "code": "insufficient_balance", "message": "..." }
}
HTTPcodeЗначение
401unauthorizedОтсутствует или недействителен API-ключ.
402insufficient_balanceНедостаточно предоплаченного баланса для цены этого заказа.
404package_not_foundpackage_code для путешествия не найден или больше не активен.
429rate_limitПревышен лимит запросов - снизьте частоту запросов.