概要
パートナーAPI(B2B)
パートナーポータルのアカウントを持つB2B販売店・提携先が、サーバーからesimoaの商品カタログを取得するAPIです。
対象#
パートナーAPIは、esimoaと契約しパートナーポータルのアカウントを持つB2B販売店・旅行会社・法人提携先向けのAPIです。esimoaが販売する商品カタログをサーバーからそのまま取得し、独自の販売・相談画面を作れます。
価格(priceKRW)はesimoaの消費者価格(ウォン)で、提供元・原価の情報はレスポンスに含まれません。
ヒント
ブログ・比較サイト・AIサービスを運営しているなら、誰でも登録してコミッションを受け取れる公開APIをお使いください。
利用の申し込み#
- 1提携のお問い合わせからご連絡ください。esimoaが確認後にアカウントを作成します。
- 2アカウント担当者(OWNER)に招待メールが届きます。リンクは72時間以内に1回だけ使え、パスワードを設定するとすぐにログインできます。
- 3パートナーポータルの APIキー メニューでキーを発行します。
ベースURL#
url
https://api.esimoa.com/b2b/v1注意
サーバー間連携専用です。外部サイトのブラウザからの呼び出しはCORSで許可していません。バックエンドから呼び出し、キーをフロントエンドやアプリのコードに入れないでください。
エンドポイント#
| エンドポイント | 説明 |
|---|---|
| GET /b2b/v1/products | 商品検索 |
| GET /b2b/v1/products/:id | 商品1件 |
| GET /b2b/v1/countries | 販売国一覧 |
すべてのエンドポイントはキーに catalog:read 権限が必要です(既定で付与されています)。
レスポンス形式#
成功時は data に結果が入り、一覧には total・page・limit も付きます。失敗時は code が入ります — message は英語で変わる可能性があるため、code で分岐してください。
json
// Success
{ "success": true, "data": ..., "total": 128, "page": 1, "limit": 20 }
// Error
{ "statusCode": 401, "code": "INVALID_API_KEY", "message": "The API key is invalid." }公開APIとの比較#
| パートナーAPI(B2B) | 公開API(/v1) | |
|---|---|---|
| キーの発行 | パートナーポータル | デベロッパーセンター |
| ページング | page (1~) · limit ≤ 50 | offset · limit ≤ 50 |
| 価格フィールド | priceKRW | priceKrw |
| 購入リンク | なし — 販売は契約に基づく | url(パートナーコード付き) |
| 提供元情報 | 含まない | provider |
| レート制限 | キーごとに毎分300回(アカウント別に調整) | パートナーごとに毎分600回 |
