推播通知 API 設定

概覽

我們提供多個推播 API,讓您在詳細資訊可供使用時,接收相關資訊,例如可用庫存、運送和財務資訊等。這些 API 可用於客戶自動化流程中。若要設定推播通知:

  • 登入 TI.com 後,請按一下使用者名稱旁的下拉式選單,並選擇「myTI 儀表板」。
  • 在 myTI 儀表板的左側導覽功能表中,按一下「公司帳戶」下的「API 金鑰和存取」。
  • 展開「TI store API 套件」區段。
  • 按一下所需設定之推播 API 旁的齒輪圖示。


如何填寫此表單

API URL:您的 API URL,此 API URL 會接受 TI 的 POST 要求。將會在此處傳送 TI API 推播通知 (在建立出貨前通知文件時的特定螢幕截圖中)。

資料格式:欲在 TI API 傳送的 POST 要求中接收的資料格式 (JSON,或如果支援 XML 亦可為 XML)。預設為 JSON。

驗證類型:呼叫您的 API 時,我們支援 2 種驗證類型:

  • 基本驗證 (在此您可定義使用者名稱和密碼,如下所示) 識別特定使用者。
  • 權杖 (在此您可提供 TI API 會以特定標頭傳送的秘密金鑰) 識別特定應用。

API 要求參數:這是選用欄位,在此您可定義呼叫您的 API 時,TI API 會納入的參數。您可以指定多個項目,例如「將日期偏移 5 天」或「將結果限制為前 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 要求參數」為選用,如果您希望在向 TI 進行 API 呼叫時建立其它設定,即可加以使用。

我們會持續發展及改善審查與核准 API 端點的程序,以及保護 API 回呼功能安全的程序,在此感謝您的合作。