開発者向け API
TourPro の開発者向け API を使うと、自作のスクリプトや外部連携ツールからご自身の TourPro データを読み取ることができます。認証にはパーソナルアクセストークンを使用し、各トークンはあなた自身の権限で動作するため、あなたが閲覧できるツアーのみにアクセスできます。
フェーズ 1 は読み取り専用です。ご自身のユーザー情報、参加ツアー一覧、およびスケジュールイベントを取得できます。
トークンを作成する
プロフィール画面を開く
Web アプリで Profile(プロフィール)を開き、Developer(開発者)タブを選択します。
トークンを発行する
Create token(トークンを作成)をクリックし、用途がわかる名前(使用するスクリプト名やサービス名など)を入力して確定します。
その場でコピーする
トークン文字列は一度しか表示されません。すぐにコピーし、パスワードと同様に厳重に保管してください。紛失した場合はトークンを取り消し(Revoke)、新しく作成し直してください。
API を呼び出す
Authorization ヘッダーに Bearer トークンとして指定して送信します。
Authorization: Bearer tourpro_...| エンドポイント | 返却されるデータ |
|---|---|
GET /api/v1/me | ユーザー ID、氏名、メールアドレス |
GET /api/v1/tours | アクセス権のあるツアー一覧 |
GET /api/v1/tours/:tourId/events | 指定ツアーのスケジュールイベント一覧(権限および公開範囲でフィルタリング済み) |
ベース URL は Web アプリではなく API ホスト(例: https://api.tourpro.app)です。
curl https://api.tourpro.app/api/v1/tours \
-H "Authorization: Bearer tourpro_..."API にはトークンごとに毎分 120 リクエストのレート制限があります。上限を超えると 429 レスポンスと、制限枠を示す RateLimit ヘッダーが返されます。
トークンを取り消す
Developer タブに戻り、対象トークンの横にある Revoke(取り消す)をクリックして確定します。取り消しは即時に反映され、元に戻すことはできません。再度必要な場合は新しいトークンを作成してください。
トークンが閲覧できる範囲
トークンがあなた自身の権限以上のデータを見ることは一切ありません。
- ツアー: あなたが作成したツアー、または参加しているツアーのみ。
- イベント: スケジュール閲覧権限があり、かつあなたのロールおよび対象日程に対して公開されているイベントのみ。
- すべて読み取り専用です。API 経由でデータが書き換えられることはありません。
アプリのログインセッションは API では使用できません。v1 エンドポイントは tourpro_ プレフィックスのトークンのみを受け付けるため、万一ブラウザセッションが漏洩しても API に対して再利用することはできません。