Tərtibatçı

HTTP API

Əsas URL https://osim.live/api/v1 — SMS təsdiqi və səyahət eSIM. Açarları paneldə yaradın, sonra Bearer ilə çağırın.

Autentifikasiya

Hər gizli sorğuda API açarını göndərin. Açarlar osim_ ilə başlayır və hesab səhifəsində yaradılır.

Authorization: Bearer osim_…

Açarları açıq frontendə yerləşdirməyin. Server tərəfi və ya backend proksi daha yaxşıdır.

Paneldə açarlar

Cavab formatı

Hər son nöqtə success bayrağı olan JSON qaytarır. Xətalar eyni formada, error mətni ilə gəlir.

// Success
{ "success": true, "data": { … } }

// Error
{ "success": false, "error": "message" }

Əsas URL: https://osim.live/api/v1
Content-Type: application/json
Brauzer müştəriləri üçün CORS açıqdır (OPTIONS dəstəklənir)
Məbləğlər USD cents ilədir, qeyd edilməyibsə (balanceCents, sellCents)

GET/api/v1

API indeksi — versiya və resurs yolları. Açar tələb olunmur.

Açıq

curl https://osim.live/api/v1

GET/api/v1/me

API açarına bağlı cari hesab: id, e-poçt, ad və cüzdan balansı.

Bearer tələb olunur

curl https://osim.live/api/v1/me \
  -H "Authorization: Bearer osim_…"

// data
{
  "id": "…",
  "email": "[email protected]",
  "name": "…",
  "balanceCents": 2500,
  "balance": "$25.00"
}

SMS təsdiqi

GET/api/v1/sms?catalog=1

Xidmətlər, ölkələr, USD qiymətləri və icazəli icarə müddətlərinin açıq kataloqu.

Açıq

curl "https://osim.live/api/v1/sms?catalog=1"

// data
{
  "services": [
    {
      "slug": "whatsapp",
      "service": "WhatsApp",
      "category": "…",
      "countries": [
        { "code": "TR", "name": "Turkey", "countryId": 12, "priceUsd": 0.35, "successRate": 92 }
      ]
    }
  ],
  "rentHours": [4, 12, 24, 72, 168]
}

GET/api/v1/sms

Son SMS sifarişlərinizi siyahılayır.

Bearer tələb olunur

Varsayılan: açar sahibinin son 50 SMS sifarişi

curl https://osim.live/api/v1/sms \
  -H "Authorization: Bearer osim_…"

POST/api/v1/sms

Alın, icarəyə götürün, statusu yoxlayın, ləğv edin, tamamlayın və ya yenidən göndərin. call-verify yoxdur.

Bearer tələb olunur

Ümumi gövdə

Sahə	Növ	Məcburi	Təsvir
`action`	string	bəli	purchase \| activation \| rent \| status \| refresh \| cancel \| complete \| resend
`service / serviceSlug`	string	bəli	Kataloq slug-u, məs. whatsapp
`countryId / country`	number	xeyr	Kataloqdakı provayder ölkə id-si (alış və kirayədə məcburi)
`priceId`	string	xeyr	Müəyyən qiymət sətrinə istəyə bağlı kilid
`maxPrice`	number	xeyr	İstəyə bağlı USD tavanı
`operator`	string	xeyr	İstəyə bağlı şəbəkə seçimi
`hours / time`	number	xeyr	Yalnız kirayə: 4 \| 12 \| 24 \| 72 \| 168
`id / activationId`	string	xeyr	Status, ləğv, tamamlama və yenidən göndərmə üçün sifariş id-si

purchase / activation

Tək istifadəlik SMS təsdiq nömrəsi (təxminən 20 dəqiqə). Zənglə təsdiq yoxdur.

curl -X POST https://osim.live/api/v1/sms \
  -H "Authorization: Bearer osim_…" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "purchase",
    "service": "whatsapp",
    "countryId": 12
  }'

rent

Daha uzun kirayə. İcazəli saatlar: 4, 12, 24, 72, 168.

{
  "action": "rent",
  "service": "telegram",
  "countryId": 16,
  "hours": 24
}

status / refresh

{ "action": "status", "id": "cm…" }

cancel · complete · resend

{ "action": "cancel", "id": "cm…" }
{ "action": "complete", "id": "cm…" }
{ "action": "resend", "id": "cm…" }  // yalnız dəstəklənəndə kirayə xətləri

Səyahət eSIM

GET/api/v1/esim?catalog=1

Açıq paket kataloqu (slug / packageCode, data, gün, satış qiyməti).

Açıq

curl "https://osim.live/api/v1/esim?catalog=1"

GET/api/v1/esim

eSIM sifarişlərinizi siyahılayır və ya id ilə birini gətirir (mümkünsə istifadə yenilənir).

Bearer tələb olunur

Varsayılan: son 50 eSIM sifarişi
Tək sifariş + istifadəsini yenilə: ?id=cm…

curl "https://osim.live/api/v1/esim?id=cm…" \
  -H "Authorization: Bearer osim_…"

POST/api/v1/esim

Plan alın, profili yeniləyin, adını dəyişin, top-up variantlarına baxın və ya top-up tətbiq edin.

Bearer tələb olunur

Sahə	Növ	Məcburi	Təsvir
`action`	string	bəli	purchase \| refresh \| rename \| topup-options \| topup
`slug / packageCode`	string	xeyr	Alış və artırma üçün kataloq paketi
`id`	string	xeyr	Yeniləmə, ad dəyişmə və artırma üçün sifariş id-si
`label`	string	xeyr	Ad dəyişmə üçün yeni görünən ad

// Purchase
{
  "action": "purchase",
  "packageCode": "turkey-5gb-30d"
}

// Refresh profile / usage
{ "action": "refresh", "id": "cm…" }

// Rename
{ "action": "rename", "id": "cm…", "label": "Trip TR" }

// Top-up options + apply
{ "action": "topup-options", "id": "cm…" }
{ "action": "topup", "id": "cm…", "packageCode": "…" }

Alış cavabında LPA aktivasiya sətri və, varsa, QR şəkil URL-i olur.

Xətalar

HTTP	Nə vaxt
`200`	`success: true`
`400`	Yoxlama / iş xətası (balans çatmır, naməlum əməliyyat, …)
`401`	API açarı yoxdur və ya etibarsızdır
`404`	Bu hesabda sifariş tapılmadı

Qeydlər

Balans alış anında USD sentlə silinir. Uğursuz provayder alışları geri qaytarılır.
Birdəfəlik SMS nömrələri adətən təxminən 20 dəqiqə işləyir. İcarə saatları kataloqdan gəlir.
Sorğu limitləri və sui-istifadə nəzarəti tətbiq oluna bilər. Yüksək həcm üçün dəstəyə yazın.
OpenAPI/Swagger ixracı hələ dərc olunmayıb — bu səhifə əsas mənbədir.