Push Notification API Setup

Overview

We offer multiple push APIs that allow you to receive detailed information as it becomes available, such as inventory availability, shipping and financial information. These APIs can be worked into customer automation flows. To set up push notifications: 
 

  • After logging in to TI.com, click the drop-down menu next to the user name and select "myTI dashboard."
  • From the myTI dashboard, on the lefthand navigation menu, click on "API Keys and Access" under "Company Account."
  • Expand the "TI store API Suite" section.
  • Click on the gear icon next to the push API you need to set up.


How to complete this form

API URL: Your API URL that will accept the POST requests from TI. TI API push notifications will be sent here (in your specific screenshot when an advance ship notice document is created).

Data format: The data format to receive in the POST request sent by the TI API (JSON or XML if supported). Default is JSON.

Authentication type: We support 2 types of authentication when calling your API:

  • Basic auth (where you define a username and password as shown below) identifies a specific user.
  • Token (where you provide a secret key that the TI API will send in a specific header) identifies a specific application.

API request parameters: This is an optional field(s) where you can define parameters that the TI API will include when calling your API. You can specify items like "offset date by five days" or "limit results to first five results."

TI is committed to securing your systems and TI's from security threats, and require that customer endpoints meet specific guidelines for enabling API callback functionality. Your push API settings in the myTI dashboard as well as individual API calls from TI to your specified endpoints will be reviewed, and access to the push APIs may be revoked if the best practices described below are not followed.

  • Use HTTPS webhook URLs with SSL encryption and a valid certificate.
  • The API should implement security scheme to restrict access. Token authentication method is preferred, but basic authentication is supported if required.
  • Do not use dynamic DNS, redirector, anonymizer or tor2web services.
  • Do not use offensive, abusive, fraudulent  or embargoed top-level domains.
  • If possible, the domain of your API URL should match your myTI customer domain.
  • Do not use IP addresses.
  • Do not use redirect or relay URL parameters.
  • Make sure that the endpoint URL you save in myTI API settings will allow external requests.
  • Make sure your firewall will allow external requests.
  • Endpoints are expected in JSON data format.
  • The "API request parameters" are optional and can be used if you want to establish additional settings  when making API calls to TI.

The process for reviewing and approving API endpoints and securing API callback functionality will continue to evolve and improve, and we appreciate your cooperation.