TI store API 套件

驗證

由於 TI store API 使用 OAuth 2.0 保障資安,因此傳送要求時必須在標頭傳遞存取權杖。若要取得存取權杖,請呼叫 OAuth API,網址為 https://transact.ti.com/v1/oauth/accesstoken

對於成功的請求,請注意:
 

  • 我們使用的是用戶端憑證流程。
  • 「Content-Type」必須為「application/x-www-form-urlencoded」。
  • 請求應傳送到上述對應的 URL,不需要其他任何查詢參數。
  • 要求參數 (grant_type、client_id、client_secret) 必須位於要求內文中、以字串傳送,並以「&」分隔,無需進一步編碼。
  • 例如:"grant_type=client_credentials&client_id=[CLIENT_ID]&client_secret=[CLIENT_SECRET]"
  • 存取權杖有效時間為 60 分鐘。在其他 API 中使用權杖之前,檢查存取權杖是否已過期。
  • 存取權杖 (或承載者權杖) 必須在所有 API 要求的標頭中傳遞。
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


回應成功請求:

{ "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" }


Insomnia 用戶端存取權杖要求的驗證負載和標頭範例:

 


Insomnia 要求 OAuth2 設定:

 


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

 

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.回應:" + responseBody); } else { Console.WriteLine("Request failed.狀態代碼:" + response.StatusCode); } } catch (Exception e) { Console.WriteLine(e.Message); } // Process the response } } } } }