コンテンツにスキップ

認証

アプリケーションは、WinkおよびTripPay APIと通信するために使用できる認証済みOAuth2セッションを作成するために必要なClient IDSecret Keyを提供します。

認証済みセッションを作成する手順は以下の通りです。

ステップ1. ステージングまたは本番環境でアクセストークンを取得します:

おそらく、言語に対応した強力なOAuth2ライブラリを使用しているため、ほとんどの処理はライブラリが行います。 ここでは、curlを使ったコマンドラインでの最も基本的な使用例を示します。

Terminal window
curl -X POST https://staging-iam.wink.travel/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=<YOUR_CLIENT_ID>" \
-d "client_secret=<YOUR_SECRET_KEY>"
Terminal window
curl -X POST https://iam.wink.travel/oauth2/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id=<YOUR_CLIENT_ID>" \
-d "client_secret=<YOUR_SECRET_KEY>"

これにより、アクセストークンとその他のOAuth2レスポンスデータが返されます:

{
"access_token": "abc123"
}

いずれかのエンドポイントにリクエストを送る際は、ヘッダーに以下を含めてください:

  • Wink-Version = 2.0 最新 - 他の利用可能なバージョンはAPIドキュメントをご覧ください。
  • Authorization = Bearer ${access_token} アクセストークンを挿入してください。

スコープはアクセストークンに付与される権限です。トークンをリクエストする際に、scopeパラメータでスペース区切りのスコープリストを渡し、トークンはそのスコープがカバーする範囲にのみアクセスできます。client_credentialsグラントでは、トークンリクエスト時にスコープを設定します — 上記のcurl例やPostmanウォークスルーを参照してください。

スコープはsection.actionという名前で、actionは以下のいずれかです:

  • read — リソースの閲覧(安全なGETリクエスト)
  • write — リソースの作成・更新(POST / PUT / PATCH
  • remove — リソースの削除(DELETE

Winkは機能別に権限をグループ化しています。統合に必要なスコープのみをリクエストしてください:

スコープグループスコープアクセス可能な内容リスク
アカウントaccount.read account.write account.removeエンティティ、チームメンバー、設定、アプリケーションの管理低〜中
インベントリinventory.read inventory.write inventory.remove物件、部屋タイプ、料金プラン、料金、アドオン、空室状況、アクティビティ、アトラクション低〜中
予約booking.read booking.write booking.remove検索、閲覧、作成、キャンセル、返金、チェックアウト、キャンセルポリシー低〜中
マーケティングmarketing.read marketing.write marketing.removeキャンペーン、特典、販売チャネル、WinkLinks、管理されたソーシャル、ロイヤリティ低〜中
コンテンツcontent.read content.write content.remove物件説明、レビュー、メディア、地図、グリーンインデックス低〜中
分析analytics.read analytics.write analytics.removeレポートと分析 — 収益、リーダーボード低〜中
統合integrations.read integrations.write integrations.removeチャンネルマネージャー、外部予約システム、Google Hotel、通知エンドポイント、予約同期低〜中
決済payment.read payment.write payment.remove決済処理、Stripe、Revolut、支払い、サブスクリプション中〜高
会計accounting.read accounting.write accounting.remove会計、出金台帳、照合中〜高
MCPmcp.read mcp.write mcp.removeAIエージェント向けのMCPトランスポート/mcp)を開く低〜中

いくつか注意点:

  • 最小限のリクエストを。 統合で実際に使用するスコープのみをリクエストしてください — 必要以上に広範囲のアクセス権を持つトークンは、漏洩時の影響範囲が大きくなります。
  • 不明なスコープは拒否されます。 登録されていない、または存在しないスコープをリクエストすると、トークン発行時に失敗します。
  • mcp.*はAIエージェントクライアント専用です。 MCPトランスポートを開くために必要であり、通常のREST API呼び出しには不要です。Model Context Protocolを参照してください。