Перейти к содержимому
API-документация

Получить пакет eSIM

GET/api/partner/v1/esim/packages/{id}
Scope
esim:read

Параметры пути

ПараметрТипОбяз.Описание
idstring (uuid)да—

Пример запроса

TS=$(date +%s)
SIG=$(printf '%s\n%s\n%s\n%s' "$TS" "GET" "/api/partner/v1/esim/packages/5b2f7c1a-3d4e-4f60-8a71-9c0d1e2f3a4b" "" \
  | openssl dgst -sha256 -hmac "$PP_SECRET" -hex | awk '{print $NF}')

curl -sS -X GET "https://api.plativputi.com/api/partner/v1/esim/packages/5b2f7c1a-3d4e-4f60-8a71-9c0d1e2f3a4b" \
  -H "X-Key-Id: $PP_KEY_ID" \
  -H "X-Timestamp: $TS" \
  -H "X-Signature: $SIG"
const res = await pp("GET", "/esim/packages/5b2f7c1a-3d4e-4f60-8a71-9c0d1e2f3a4b");
res = pp("GET", "/esim/packages/5b2f7c1a-3d4e-4f60-8a71-9c0d1e2f3a4b")
$res = pp('GET', '/esim/packages/5b2f7c1a-3d4e-4f60-8a71-9c0d1e2f3a4b');

pp() — функция-обёртка с подписью из раздела Аутентификация и подпись.

Ответ

200 OK — EsimPackageDTO

ПолеТипОбяз.Описание
countriesarray<string>даISO alpha-2 коды стран, которые покрывает пакет. Пусто, если провайдер не опубликовал список.
currencystringнет—
data_gbstringдаОбъём трафика в ГБ, десятичная строка. Не имеет смысла, если unlimited = true.
has_5gbooleanдаtrue, если в опубликованной сети упомянут 5G. false означает и «не указано».
idstringдаИдентификатор пакета — передайте его как package_id в POST /esim/orders
networkstringнетПоколение сети / операторы, как их опубликовал провайдер, если известны
price_usdstringнетСколько покупка этого пакета спишет с вашего баланса, USD
region_codestringдаISO 3166-1 alpha-2 для пакета одной страны, иначе код региона (EUROPE, ASIA, GLOBAL, …)
region_namestringда—
smsintegerнетВключённые SMS, если они есть в пакете
titlestringда—
unlimitedbooleanда—
validity_daysintegerда—
voice_minutesintegerнетВключённые минуты звонков, если они есть в пакете

Примеры ответа

{
  "id": "5b2f7c1a-3d4e-4f60-8a71-9c0d1e2f3a4b",
  "title": "Turkey · 5GB 30 days",
  "region_code": "TR",
  "region_name": "Turkey",
  "countries": [
    "TR"
  ],
  "data_gb": "5",
  "unlimited": false,
  "validity_days": 30,
  "network": "4G/5G",
  "has_5g": true,
  "price_usd": "5.26",
  "currency": "USD"
}
{
  "title": "Not Found",
  "status": 404,
  "detail": "partner_esim_package_not_available",
  "errors": [
    {
      "message": "esim_package_not_available",
      "location": "error.code",
      "value": "esim_package_not_available"
    }
  ]
}

Ошибки

HTTPКодКогда
404esim_package_not_availableПакет eSIM неизвестен, снят с продажи или сейчас недоступен. Возьмите актуальный из GET /esim/packages. Деньги не двигались.
404tariff_not_availableeSIM для вашего аккаунта не включён.

Плюс общие ошибки подписи и лимитов — см. Ошибки.