APIトークンの作成と使用方法
APIトークンを使用すると、別のシステムからTicketingHubアカウントに接続できます。APIトークンを管理するには、管理者アクセス権が必要です。
APIトークンは何に使用できますか？
- TicketingHubのデータをレポート作成ソフトウェアやデータウェアハウスに送信する。
- カスタムパートナープラットフォームから商品や価格を読み取れるようにする。
- 空き状況をリアルタイムで確認できる、サーバーサイドの予約画面を構築する。
APIトークンによって、Googleスプレッドシートとの組み込み連携が作成されるわけではありません。CSVエクスポート、Zapier、ウェブフック、APIアクセスのいずれを使用するかについては、TicketingHubのデータをエクスポートして他のツールに接続する方法をご覧ください。
APIアクセスを有効にする
- 設定 → 機能に移動します。
- APIアクセスをオンにします。
これはセルフサービスで変更できる設定です。有効にすると、設定にAPIトークンが表示されます。
トークンを作成する
- 設定 → APIトークンに移動します。
- APIトークンを生成を選択します。
- トークンを使用するシステムを識別できる名前を入力します。
- サプライヤー管理にはSupplier API (V2)、空き状況と予約にはWidget API、OCTO標準に対応するシステムとの接続にはOCTO APIを選択します。
- Supplier API (V2)またはOCTO APIを選択した場合、連携でデータの閲覧のみが必要であればRead-onlyを選択できます。このオプションはWidget APIトークンには適用されません。
- 必要に応じて有効期限を追加し、トークンを生成します。
- トークンをすぐにコピーして、安全に保管します。完全なトークンが表示されるのは一度だけです。
トークンを使用する
各APIリクエストのAuthorizationヘッダーにトークンを含めて送信します。
Authorization: Bearer YOUR_TOKENAPIトークンは、安全なサーバーサイドシステムでのみ使用してください。ウェブサイトのコード、メール、チャットメッセージ、共有ドキュメントにはトークンを記載しないでください。
トークンを取り消す
設定 → APIトークンに移動し、対象のトークンの横にある取り消しを選択します。取り消しは直ちに反映されるため、接続先のシステムは交換用のトークンを使用するまで動作しなくなります。
連携ごとに別のトークンを作成し、必要なアクセス権だけを付与して、使用しなくなったトークンは取り消してください。イベントベースの更新には、ウェブフックまたはZapier連携の方が適している場合があります。