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.

Follow these steps to set up push notifications: 

  1. Access your dashboard: Log in to your account and navigate to the myTI dashboard from the user menu dropdown.
  2. Locate API keys and access: From the myTI dashboard, go to the navigation menu and select “API keys and access” under “Company account.”
  3. Choose your push API: Expand the "TI store API Suite" section.- Select the gear icon next to the specific push API you want to enable.

 


How to complete this form

This guide explains how to configure push notifications for advance ship notice (ASN) documents.

API URL:

  • Enter the URL of your API endpoint that can receive POST requests.
  • TI API push notifications will be sent here (in your specific screenshot when an ASN document is created).

Data format:

  • Select the data format to receive in the POST request sent by the TI API (JSON or XML if supported).
  • JSON is the default.

Authentication type:

We support 2 authentication methods:

  • Basic auth: Enter a username and password to identify a specific user.
  • Token auth: Provide a secret key that the TI API will send in a specific header to identify your application.

API request parameters (optional): 

  • You can define optional parameters for the TI API to include when calling your endpoint.

Security requirements

TI is committed to protecting both your systems and ours from security threats, and we require that your API endpoints meet specific guidelines:

  • Use HTTPS webhook URLs with SSL encryption and a valid certificate.
  • Implement security scheme to restrict access. We recommend token authentication, but basic authentication is also supported.
  • Avoid:
    • Dynamic DNS, redirectors, anonymizers or Tor2web services.
    • Offensive, abusive, fraudulent  or embargoed top-level domains.
    • IP addresses.
    • Redirect or relay URL parameters.
  • Match your API URL domain to you myTI customer domain, if possible.
  • Ensure your firewall allows external requests to your endpoint URL.

Data format

The data sent by our API will be in JSON format.

Continuous improvement

We are constantly improving the process for reviewing and approving API endpoints. We appreciate your cooperation in maintaining a secure environment.