esimaccess-api について
eSIM Access API Skillは、eSIM Access APIを使ったアカウント、プラン、注文、プロファイルの操作をエージェントに案内します。参照系の確認から状態変更まで扱い、キャンセルと再注文の手順も含みます。
主な機能
- 01残高、地域、プラン、使用量の確認
- 02注文作成とeSIMへのデータ追加
- 03注文とeSIMプロファイル状態の確認
- 04キャンセル、一時停止、無効化の管理
- 05Webhook設定とSMS送信
活用シーン
- 01渡航先で利用可能なプランの確認
- 02eSIMの注文とICCIDの追跡
- 03対象eSIMへのデータ追加
- 04未使用eSIMのキャンセルと代替プランの注文
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ esimaccess/ esimaccess-api --skill esimaccess-apiインストール後、Claude Code で/esimaccess-apiを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdLICENSEreferences/api-reference.mdscripts/test-esim-api.mjs詳細
eSIM Access API スキル
eSIM Access API を操作して、eSIM のライフサイクル全体を管理します。
このスキルを使う場面
次のような場合にこのスキルを使用します。
- ユーザーが eSIM の操作(注文、チャージ、キャンセル、ステータス確認)について質問する
- ICCID、注文番号、QR コード、データ使用量について言及する
- アカウント残高の確認や、利用可能なデータパッケージの一覧表示を希望する
- ローミング、旅行用データプラン、モバイル接続について質問する
- eSIM プロファイルの管理(一時停止、一時停止の解除、無効化)が必要である
- eSIM ステータス通知用の Webhook の設定を希望する
- eSIM のキャンセルと再発行(返金/交換のワークフロー)を希望する
- eSIM Access API または api.esimaccess.com に言及する
プロンプトの例
- 「eSIM Access の残高を確認して」
- 「日本で利用できるパッケージは何ですか?」
- 「米国向けの 5GB プランを注文して」
- 「注文番号 B26041021130002 のステータスを確認して」
- 「ICCID 89852240810733629810 のデータ使用量はどれくらいですか?」
- 「eSIM に 5GB を追加して」
- 「この未使用の eSIM をキャンセルして返金して」
- 「注文通知用の Webhook を設定して」
クイックリファレンス
- ベース URL:
https://api.esimaccess.com/api/v1/open - 認証: HMAC-SHA256 署名付きヘッダー — accessCode は API 識別子と署名キーの両方に使用します(
references/api-reference.mdを参照) - 価格: API の値 / 10,000 = USD(例:18000 = $1.80)
- 容量: バイト(1073741824 = 1 GB)
- 認証情報: accessCode は https://console.esimaccess.com/developer/index から取得します
操作
読み取り(安全)
| 操作 | エンドポイント | 目的 |
|---|---|---|
check_balance | /balance/query | アカウント残高(USD) |
list_regions | /package/list | 対応するすべての国 |
list_packages | /package/list | 国/コード別の商品 |
list_topup_packages | /package/list | ICCID のチャージオプション |
check_order_status | /esim/query | 注文の詳細 + ICCID |
check_esim_status | /esim/query | eSIM プロファイルの全情報 |
check_data_usage | /esim/usage/query | データ使用量の統計 |
query_webhook | /webhook/query | 現在の Webhook 設定 |
書き込み(費用が発生、または状態を変更)
| 操作 | エンドポイント | 目的 |
|---|---|---|
create_order | /esim/order | 新しい eSIM を購入 |
apply_topup | /esim/topup | 既存の eSIM にデータを追加 |
cancel_esim | /esim/cancel | 未使用の eSIM をキャンセル(返金) |
suspend_profile | /esim/suspend | 一時的に無効化 |
unsuspend_profile | /esim/unsuspend | 一時停止中のプロファイルを再有効化 |
revoke_profile | /esim/revoke | 永続的に無効化(返金なし) |
send_sms | /esim/sendSms | eSIM に SMS を送信 |
setup_webhook | /webhook/save | 通知 URL を設定 |
複合ワークフロー
| 操作 | 目的 |
|---|---|
refund_and_reissue | 未使用の eSIM をキャンセルし、返金を確認して、同じパッケージで代替品を注文 |
重要なルール
- 注文フロー:
create_orderはorderNoを返します。ICCID を取得するため、check_order_statusを 3 秒ごとにポーリングします(4 回まで再試行)。ORDER_STATUS Webhook は代替手段です。 - チャージ: ICCID ではなく
esimTranNoを使用します。supportTopUpType === 2はチャージ対象であることを意味します。有効期限後はチャージできません。 - キャンセルと無効化の違い: キャンセルは未使用の eSIM(RELEASED/GOT_RESOURCE)に適用でき、返金されます。無効化は有効化済みの eSIM に適用でき、返金はありません。
- 使用量の照会: ICCID ではなく
esimTranNoが必要です。必要に応じて、まず/esim/queryで ICCID を照会します。 - SMS:
contentではなくmessageフィールドを使用します。有効化済みの eSIM でのみ機能します。
あらゆる言語での認証
references/api-reference.md ファイルには、Node.js と Python の HMAC-SHA256 認証例が記載されています。そこに記載されている署名アルゴリズムを使用して、希望する言語で認証コードを生成するよう AI に依頼してください。
テスト
node scripts/test-esim-api.mjs <accessCode>
インストール
あらゆる AI エージェント(Skills CLI 経由)
npx skills add esimaccess/esimaccess-api
手動インストール
https://app.esimaccess.com/public/skill/ からダウンロードし、エージェントのスキルディレクトリに配置します。
ファイル
| ファイル | 用途 |
|---|---|
SKILL.md | このファイル — スキルの定義 |
scripts/test-esim-api.mjs | 15 件のエンドツーエンド API テスト |
references/api-reference.md | API ドキュメント全文:エンドポイント、認証、ステータス状態、Webhook、エラーコード |
コメント
Markdown 対応