BarTender Cloud REST API 应用程序类型
問題
哪些類型的應用程式可以對 REST API 進行 RESTful 呼叫?有何不同?
適用於
BarTender Cloud REST API
Automation 訂閱
解答
進行 REST API 呼叫時,應用程式必須在 API 閘道處理呼叫之前傳送權杖並取得授權。雖然兩種類型的應用程式都需要權杖才能通過防護閘,但取得權杖的方法不同。
這兩種類型的應用程式為:
- 專用/直接應用程式 - Insomnia、Postman 等
- Web 應用程式 - 自訂應用程式
專用應用程式
專用應用程式,有時稱為直接應用程式,將 API 呼叫用直接傳送至 REST API,並且不會在這些 API 呼叫之外進行任何額外的呼叫。Insomnia 和 Postman 等應用程式屬於這種類別。
直接應用程式使用權杖通過防護閘並進行 API 呼叫。
權杖必須從 Cloud 的 Web 介面手動擷取,並且可以在您的個人資料設定或「管理雲端帳戶」的 Cloud API 區段下找到:
對於直接應用程式,安全性權杖必須與所有 API 呼叫一起傳送。 例如,在 Insomnia 中,「驗證」索引標籤可以帶有權杖。權杖被列示為持有人權杖 (由 Insomnia 的訊息持有人提供的授權權杖)。選取權杖選項後,貼上權杖,權杖將隨 API 訊息一起傳送。
Web 應用程式
Web 應用程式是以 C# 等語言所建置的功能齊全的介面。它允許使用者互動,包括登入以向 Cloud 進行驗證。此類型的應用程式需要額外的步驟來擷取權杖,並最終通過防護閘來進行 API 呼叫。下面是授權程序的流程圖。
這看起來需要很多額外步驟,為何還要選擇此類型而非直接應用程式呢? OAuth 身分識別提供者的驗證程序會在每次登入時重新整理安全性權杖,使用者永遠不需要直接處理權杖。一切都由 OAuth 和應用程式本身處理。一旦應用程式擁有有效權杖,它就可以開始傳送 API 呼叫並通過防護閘。
Web 應用程式必須在 Cloud 上註冊。這可確保僅有取得授權的應用程式才能使用 Cloud。任何未經授權的應用程式都將被拒絕存取。註冊位於 Cloud Web 介面上使用者個人資料設定或「管理雲端帳戶」中的 Cloud API 區段下。
註冊 Web 應用程式時,系統會詢問您一些關於應用程式本身的問題。每一個欄位都有一個簡短說明 (例如儲存名稱和說明),這種言簡意賅的說明可確保將正確的資訊輸入正確的位置,以及正確註冊應用程式。
所有應用程式都會出現在「Web 應用程式註冊」區段下的清單中。
啟動時,會有幾個範例說明如何撰寫自訂 Web 應用程式,以及如何建置驗證對話方塊。您可以在這裡的 BarTender Cloud 說明中找到此內容及更多資訊。