TI store API suite

Authentication

TI store APIs use OAuth 2.0 for secure access. To interact with them, you will need an access token included in the request header. To obtain an access token, call the OAuth API at https://transact.ti.com/v1/oauth/accesstoken.

Obtaining an access token

We use the client credentials flow to get tokens. Ensure the following for a successful request:

Content-Type: Set it to "application/x-www-form-urlencoded”
Request URL: Use the provided URL without additional query parameters.
Request body: Include these parameters (separated by “&” without encoding):
- grant_type
- client_id
- client_secret

Example request body:

"grant_type=client_credentials&client_id=[CLIENT_ID]&client_secret=[CLIENT_SECRET]"

Using the access token

The token is valid for 60 minutes. Before using the token in other APIs, check whether the access token has expired.
Include the access token (also called a bearer token) in the header of all API requests.

curl --request POST \   
       --url https://transact.ti.com/v1/oauth/accesstoken \   
       --header 'Content-Type: application/x-www-form-urlencoded' \   
       --data grant_type=client_credentials \   
       --data client_id=XXXXXXXXXXXXXXXXX \   
       --data client_secret=XXXXXXXXXXXXXXXXX

Response for a successful request:

{
    "access_token": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
    "token_type": "bearer",
    "expires_in": 3599,
    "scope": "",
    "application_name": "app_name",
    "developer.email": "api-portal@list.ti.com",
    "issued_at": "1582220284531",
    "client_id": "IwOjYzmalmM2YxOT15MGE3YmNm4DFkyTVk"
}

Example authentication payload and header of an access token request from Insomnia client:

Insomnia request OAuth2 Settings:

Authentication example in VB.net (framework 4.6.1):

Imports System.Net
Imports System.IO
Imports System.Text
Imports Newtonsoft.Json.Linq

Private Function GetToken() as string

        Dim URL As String = "https://transact.ti.com/v1/oauth/accesstoken"

        Dim ClientID As String = "{myTI API Key}"
        Dim ClientSecret As String = "{myTI API Secret}"
        Dim Data As String = $"grant_type=client_credentials&client_id={ClientID }&client_secret={ClientSecret}"

        Dim request As HttpWebRequest = DirectCast(WebRequest.Create(URL), HttpWebRequest)
        request.Method = "POST"
        request.ContentType = "application/x-www-form-urlencoded"   
        Dim byteArray As Byte() = Encoding.UTF8.GetBytes(Data)
        request.ContentLength = byteArray.Length
        Dim dataStream As Stream = request.GetRequestStream()
        dataStream.Write(byteArray, 0, byteArray.Length)
        dataStream.Close()
        Dim response As HttpWebResponse = DirectCast(request.GetResponse(), HttpWebResponse)
        dataStream = response.GetResponseStream()
        Dim reader As New StreamReader(dataStream)
        Dim result As String = reader.ReadToEnd()
        reader.Close()
        dataStream.Close()
        response.Close()

        Dim parsejson As JObject = JObject.Parse(result)

        return parsejson.SelectToken("access_token").ToString

End Function 

Authentication example in C# (framework 4.6.1):

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using System.Net.Http;

namespace WindowsFormsApp1
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {

        }

        private void button1_Click(object sender, EventArgs e)
        {
            GetToken();
        }

        static async Task GetToken()
        {
            string apiUrl = "https://transact.ti.com/v1/oauth/accesstoken";

            // Create the HttpClient
            using (HttpClient client = new HttpClient())
            {
                // Prepare the data to send
                var formData = new FormUrlEncodedContent(new[]
                {
                new KeyValuePair<string, string>("grant_type", "client_credentials"),
                new KeyValuePair<string, string>("client_id", "{myTI API Key}"),
                new KeyValuePair<string, string>("client_secret", "{myTI API Secret}"),
                // Add more key-value pairs as needed
            });

                // Prepare the PUT request
                using (HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Put, apiUrl))
                {
                    request.Content = formData;
                    try
                    {
                        request.Headers.Add("Accept", "application/json"); // Optional, set the desired response format}
                    }


                    catch (Exception e)
                    {
                        Console.WriteLine(e.Message);
                    }


                    // Send the request and get the response
                    try
                    {
                        HttpResponseMessage response = await client.SendAsync(request);
                        if (response.IsSuccessStatusCode)
                        {
                            string responseBody = await response.Content.ReadAsStringAsync();
                            Console.WriteLine("Request successful. Response: " + responseBody);
                        }
                        else
                        {
                            Console.WriteLine("Request failed. Status code: " + response.StatusCode);
                        }
                    }
                    catch (Exception e)
                    {
                        Console.WriteLine(e.Message);
                    }
                    // Process the response

                }
            }
        }
    }
}