メインコンテンツへスキップ
SimVoro
アカウントを読み込み中…
SimVoro

API連携

利用可能

API連携

自社のアプリや予約フローの中でeSIMを販売する予定ですか?必要なことをお知らせください。

承認後、営業担当がアクセスを有効にしたパートナーはAPIを利用できます。パートナーダッシュボードで読み取り専用または注文可能なキーを作成します。購入にはUSDのプリペイドウォレットを使用します。

APIクイックスタート

アカウント承認後、営業担当が価格を設定しAPIアクセスを有効にします。パートナーダッシュボードでキーを作成してください。読み取り専用キーでは注文できません。アカウントの購入権限も必要です。

https://simvoro.com/api/partner/v1

すべてのリクエストでサーバー側のBearerキーを送信してください。ブラウザーのコードやURLにキーを含めないでください。キーはパートナーダッシュボードで取り消せます。

Authorization: Bearer YOUR_API_KEY
メソッドエンドポイント結果
GET/products?destination=japan設定されたUSD価格と商品ID。目的地のslugで絞り込み、cursorでページを切り替えます。
GET/balanceウォレット残高、保留中の金額、利用可能なUSD。
GET/transactionsウォレット取引とnextCursor。
GET/ordersパートナー注文の概要とnextCursor(1ページ50件)。
POST/orders資金を確保してeSIMを1件注文します。注文権限のあるキーが必要です。
GET/orders/{orderId}注文状況、最終同期時点のデータ使用量、受け渡し後のインストール情報。

注文を作成

Idempotency-KeyにUUIDを送信してください。タイムアウトや接続障害の後も同じUUIDを再利用します。顧客が確認した価格を送信し、受取端末がeSIM対応かつSIMロック解除済みであることを確認してください。実際の価格が変わると409 PRICE_CHANGEDが返ります。本番APIのため、受け付けた購入には実際のウォレット資金を使用します。

POST /api/partner/v1/orders
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Idempotency-Key: 83c77d9f-395f-4ff0-8ed6-c461bda46559

{"productId":"PRODUCT_ID_FROM_CATALOG","expectedPrice":"2.25","deviceConfirmed":true}

201レスポンスにはorderIdとesimが含まれます。esim.statusとesim.failureを確認してください。注文は10秒間隔で確認します。資金は先に確保され、eSIMの受け渡し確認後に引き落とされます。再送時に失敗済み注文が返る場合もあります。仕入先の結果が不明な場合、元の注文を照合する間は資金を確保したままにします。インストール情報は非公開で、受け渡し確認後にのみ表示されます。

金額はUSDの小数文字列です。一覧はitemsとnextCursorを返し、nextCursorがnullになるまで取得します。制限はキーごとに毎分120リクエスト、ユーザーごとに毎分10回の購入試行です。429ではRetry-Afterに従ってください。主なエラーは401キー無効、403権限なし、402残高不足、404注文にアクセス不可、409価格または重複防止キーの競合、503サービス利用不可です。再購入の前に元の注文を確認してください。

リクエストに含める内容

  • 自社のプラットフォームと顧客層
  • 月間の想定数量
  • 提供したい渡航先
  • システムで必要な処理(例:eSIMを注文し、そのQRコードを顧客に表示する)

パートナーになる

申し込みを送信すると、その内容について担当チームから連絡します。