PhoenixPass API

Создание eSIM

POST
/api/v1/b2b/fulfilment/esims

Берёт свободную eSIM из пула клиента и назначает начальный пакет по package_template_id одной атомарной операцией. Возвращает данные активации выпущенной eSIM.

Параметры active_period и validity_period опциональны и переопределяют стандартный срок действия пакета из шаблона.

Этот вызов расходует eSIM из пула, поэтому всегда передавайте ключ идемпотентности, чтобы исключить повторный выпуск на одну операцию при повторном вызове.

Authorization

Bearer esim:write

Header Parameters

X-Request-ID?string

Уникальный идентификатор для трассировки запроса. Не влияет на логику исполнения запроса.

Idempotency-Key*string

Уникальный ключ идемпотентности запроса (строка длиной до 256 символов), TTL 72ч.

См. раздел "Идемпотентные запросы"

Lengthlength <= 256

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Обратите внимание, что active_period и validity_period переопределяют стандартную механику срока действия пакета из шаблона.

При указании validity_period пакет начинает быть активным с момента его привязывание к симкарте. При указании active_period указывается окно его действия с определенной даты по определенную.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/b2b/fulfilment/esims" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "package_template_id": 0  }'
{  "iccid": "8948010000000000000",  "activation_code": "K1-1JL898-DKUTDC",  "qr": "LPA:1$smdp.io$K1-1JL898-DKUTDC",  "smdp": "smdp.io"}