バージョン

変更履歴

APIは/v1のようなパスで版を管理します。互換性のない変更は新しいパスとし、/v1を暗黙に変更しません。Webhookは別管理です。現行仕様：v2.4.0。

v2.4.0最新版

追加OpenAPIを許可された会員はapi-testing.tongkhoesim.comでtke_member_test_キー、仮想残高、模擬注文/eSIM、サンプルとシナリオを利用できます。キー管理は本番/テストを分離し、テストデータは実際の残高、履歴、ランク、請求書に影響しません。
注記会員の一括注文とWebhookは非対応のままです。返金審査は本番専用で、テストキャンセルは仮想残高に返金します。会員seed/resetにはIdempotency-Key、resetにはreasonが必要です。テストでは実際のプロバイダーを呼ばず、実際のMISA請求書も発行しません。

v2.3.0安定版

追加管理者が承認した一部の会員は本番Open APIキーを利用できます。注文、ウォレット、返金、請求書は会員所有のままです。合意済み個別価格は最終価格で、ランク割引を重ねて適用しません。
注記会員向けGET/POST /v1/esims/{id}/refund-requestsと、会員注文の任意項目invoice_buyerを追加しました。購入者を省略すると既存の消費者請求書フローを維持します。一括注文、Webhook、テストモードは組織専用で、会員にはcapability.not_supportedを返します。

v2.2.0安定版

追加eSIMのWebhook（esim.delivered、esim.activated、esim.usage_threshold、esim.expiring）にorder_idとexternal_refを追加し、追加APIなしで自社注文と照合できます。
追加GET /v1/esims、GET /v1/esims/{id}、items[]にexternal_refを追加しました。?external_ref=…で注文のeSIMを検索でき、?iccid=…でidも取得できます。
追加POST /v1/testmode/esims/{id}/simulateでstatus enabledを模擬すると、本番と同じくesim.activatedを1回だけ送信します。
注記/v1/catalog/packagesの価格は契約価格も含め、組織に実際に請求される金額です。
注記既存項目の変更・削除はなく追加のみです。external_refは常に存在し、未指定時はnullです。

v2.1.0安定版

追加組織の供給元範囲でカタログ・詳細・注文・plan-optionsを制限します。範囲外はpartner.package_not_visible / order.package_not_allowedです。filtered_by_provider_scopeで警告し、catalog.updatedは範囲内SKUのみ含め、供給元は開示しません。
注記範囲制限のない組織には変更ありません。

v2.0.0安定版

追加/v1を統一：{items, next_cursor, page_size, total, mode, warnings[]}、各実体のid、金額{amount, currency}、usage{}、?include=lpaでのインストール情報、cancellable{allowed,reason,disclosed_at}。topup-options/topupはplan-options/change-planに変更。
追加テストはapi-testing.tongkhoesim.comとtke_test_、本番はtke_live_専用です。ホスト不一致は403 partner.wrong_hostです。/v1/testmode/*にstatus、seed、reset、esims/{id}/simulate、webhooks/fire、webhooks/fail-nextを追加し、初回キーでのサンプル生成と使用量自動増加に対応しました。
注記このバージョン以前の連携パートナーはなく、ここから仕様を安定化します。