プッシュ型通知 API のセットアップ
概要
TI は複数のプッシュ型 API を提供しており、ユーザー (顧客やその代理人) はこれらを使用して、在庫状況、配送状況、財務情報などの詳細情報が入手可能になった時点で、それらの情報を入手することができます。これらの API を、顧客の自動化フローに組み込んで動作させることができます。
プッシュ型通知をセットアップするには、次の手順に従います。
- ダッシュボードにアクセス:ご自分のアカウントにログインし、ユーザー メニュー ドロップダウンから myTI ダッシュボードに移動します。
- API キーの検索とアクセス:myTI ダッシュボードからナビゲーション メニューに移動し、「法人アカウント」 (Company Account) の下にある「API キーとアクセス」 (API Keys and Access) を選択します。
- プッシュ型 API を選択:「TI store API スイート」(TI store API Suite) セクションを展開します。その後、有効にする特定のプッシュ型 API の隣にある歯車のアイコンを選択します。
このフォームに記入する方法
このガイドでは、ASN (高度配送通知) 資料のプッシュ型通知を構成する方法について説明します。
API URL:
- POST (投稿) 要求を受信できる API エンドポイントの URL を入力します。
- この API URL 宛に TI の API プッシュ通知が送信されます (この具体的なスクリーンショットは、ASN 資料が作成されたときに表示されるものです)。
データ フォーマット:
- TI API が送信する POST (投稿) 要求で受信するデータ フォーマットを選択します (JSON または XML:後者は、XML がサポートされている場合です)。
- デフォルトは JSON です。
認証の種類:
TI は、以下の 2 種類の認証方式をサポートしています。
- 基本認証:特定のユーザーを識別するためのユーザー名とパスワードを入力します。
- トークン認証:アプリケーションを識別するために、TI API が特定のヘッダーの中で送信する秘密鍵を指定します。
API 要求パラメータ (オプション):
- エンドポイントを呼び出すときに、TI API に含めるオプション パラメータを定義できます。
セキュリティ要件
TI は、お客様のシステムと TI のシステムの両方をセキュリティの脅威から保護する対策に取り組んでいます。そのため、お客様の API エンドポイントが以下の特定のガイドラインを満たすことを要求します。
- SSL 暗号化を実行し、有効な証明書を指定して、HTTPS Webhook URL を使用します。
- アクセスを制限するためのセキュリティ方式を実装します。TI はトークン認証を推奨しますが、基本認証も対応しています。
- 回避すべき事項:
- ダイナミック DNS、リダイレクタ、匿名化、または Tor2Web サービス。
- 攻撃的な、不正な、詐欺的な、または禁止されているトップ レベル ドメイン。
- IP アドレス。
- リダイレクトまたはリレー URL パラメータ。
- 可能な場合、貴社の API URL ドメインを、myTI の顧客ドメインと一致させてください。
- ファイアウォールがエンドポイント URL への外部要求を許可していることを確認してください。
データ フォーマット
TI API が送信するデータは、JSON 形式です。
継続的な改善
TI は、API エンドポイントの確認と承認のプロセスを常に改善しています。セキュアな環境の維持にご協力をお願いいたします。