プッシュ型通知 API のセットアップ

概要

TI は複数のプッシュ型 API を提供しており、ユーザー (顧客やその代理人) はこれらを使用して、在庫状況、配送状況、財務情報などの詳細情報が入手可能になった時点で、それらの情報を入手することができます。これらの API を、顧客の自動化フローに組み込んで動作させることができます。プッシュ型通知をセットアップする方法：
 

  • TI.com にログインした後、ユーザー名の隣にあるドロップダウン メニューをクリックし、「myTI ダッシュボード」を選択します。
  • myTI ダッシュボードの左側にあるナビゲーション メニューで、「法人アカウント」 (Company Account) の下にある「API キーとアクセス」 (API Keys and Access) をクリックします。
  • 「TI store API スイート」 (TI store API Suite) を展開します。
  • セットアップする必要のあるプッシュ型 API の横にある歯車のアイコンをクリックします。


このフォームに記入する方法

API URL:  TI からの POST (投稿) 要求を受け入れる、貴社の API URL。この API URL 宛に TI のプッシュ通知が送信されます (この具体的なスクリーンショットは、API 資料が作成されたときに表示されるものです)。

Data format (データ形式)： お客様が POST (投稿) の要求を受け取るときに希望する形式です (JSON または XML：後者は、XML がサポートされている場合です)。デフォルト (初期設定) は JSON です。

Authentication type (認証の種類)：ユーザー側の API を呼び出すとき、TI は以下の 2 種類の認証方法をサポートしています。

  • Basic auth (基本認証) は特定のユーザーを識別します (以下に示すようにユーザー名とパスワードを定義する場合)。
  • Token (トークン) は、特定のアプリケーションを識別します (TI API は特定のヘッダーの中で秘密鍵をユーザー宛に送信します。ユーザーは後ほど、トークンを使用してその秘密鍵を TI に提示します)。

API Request parameters (API 要求パラメータ)：これはオプションのフィールドであり、ユーザーは複数のパラメータを定義することができます。その場合、TI API はユーザー側の API を呼び出すときにそれらのパラメータを指定します。ユーザーは、「offset date by 5 days」 (最近 5 日以内) などを指定すること、または「results to first 5 results」 (検索結果を最初の 5 件) に制限することなどが可能です。

TI は、顧客のシステムと TI のシステムをセキュリティの脅威から保護する対策に取り組んでいます。その一環として、API コールバック機能を有効にするために、顧客の各エンドポイントが特定のガイドラインを満たすことを要求します。myTI ダッシュボード内にある顧客のプッシュ型 API 設定、および顧客が指定したエンドポイントに対する TI の個別の API 呼び出しが確認の対象になります。顧客が、以下に示すベスト プラクティスに従わない場合、プッシュ型 API へのアクセス権が取り消される可能性があります。

  • SSL 暗号化を実行し、有効な証明書を指定して、HTTPS Webhook URL を使用します。
  • この API は、アクセスを制限するためのセキュリティ方式を実装する必要があります。望ましいのはトークン認証方式ですが、必要な場合は基本認証もサポートされます。
  • ダイナミック DNS、リダイレクタ、匿名化、Tor2Web のどのサービスも使用しないでください。
  • 攻撃的、ののしり、詐欺、または当局による禁輸や禁止などに関連するトップ レベル ドメインを使用しないでください。
  • 可能な場合、API URL のドメインが myTI の顧客ドメインと一致しているのが望ましいことです。
  • (ドメインの代わりに) IP アドレスを使用しないでください。
  • リダイレクトまたはリレー形式の URL パラメータを使用しないでください。
  • 顧客が myTI API 設定に保存するエンドポイント URL が、外部からの要求を許可していることを確認します。
  • 顧客のファイアウォールが外部からの要求を許可していることを確認します。
  • エンドポイントは、データ形式として JSON を指定することが期待されています。
  • 「API request parameters」 (API 要求パラメータ) はオプションであり、顧客が TI に対して API 呼び出しを行うときに、追加設定を確立する目的で使用できます。

API エンドポイントの確認と承認、および API コールバック機能に関するセキュリティ確保のプロセスは、今後も進化と改良を続けていきます。顧客側でのご対応が必要になることもありますが、ご協力くださいますようお願いいたします。