vigxo 一括購入API

トラベルeSIMを発行する。プログラムから。

APIを1回呼ぶと、同じプランのeSIMを複数枚、数量に応じた料金で注文できます。旅行者ごとにインストール案内を届けられ、結果はステータスURLから読み取ります。

使い始めは、短いやり取りのあとです。画面だけで申し込んで終わるものではありません。料金も請求の条件も、自動で当てた数字ではなく、実際の話にするためです。

シンプル
Idempotency-Keyを付けた、認証済みのPOSTが1本です。呼び出しは注文を受け付け、idを返します。同じキーでもう一度呼んでも、その注文は買い直しになりません。
非同期
発行は、202の応答のあとも続きます。準備ができたeSIMのインストール情報は、注文をGETして読み取ります。実装するwebhookはありません。
管理できる
注文の支払いは、法人アカウントの前払い残高からです。各キーには、任意で日次と月次の利用上限を付けられます。
数量料金
ご利用の数量に合わせてお見積もりします。1枚だけの通常購入と同じ料金ではありません。

仕組み

POST https://vigxoesim.com/api/v1/bulk/orders
Authorization: Bearer <your API key>
Idempotency-Key: <unique per attempt>
Content-Type: application/json

{
  "planSlug": "<slug from GET /api/plans>",
  "quantity": 2,
  "locale": "en",
  "travelers": [
    { "name": "Ada Lovelace", "email": "ada@example.com" },
    { "name": "Grace Hopper", "email": "grace@example.com" }
  ]
}

202 { "orderId": "…", "status": "pending" }

GET https://vigxoesim.com/api/v1/bulk/orders/<orderId>

ステータスの応答には、準備ができたeSIMが並びます。ニックネーム、インストール情報、有効期限です。旅行者リストがあるときは、各自にインストール案内が届き、あなたにはまとめが1通届きます。リストがないときは、インストール案内はそれぞれ連絡先のアドレスに届きます。

一括購入APIのリファレンスを読む