BarTender Cloud REST API 身份验证和令牌
問題
驗證作業如何運作?何謂權杖?
適用於
BarTender Cloud REST API
解答
Cloud REST API 需要驗證,呼叫無法直接到達 API 閘道。 不可以使用基本驗證或根本不進行任何驗證就傳送指令。未經授權的呼叫會被驗證閘道阻止,無法繼續。
下面是關於驗證作業如何運作的基本資訊。
何謂權杖?
API 使用存取權杖而不是使用使用者名稱和密碼。權杖是一長串英數字元和符號,看起來像是無意義,但包含關於誰在進行 API 呼叫以及這些呼叫應該前往何處的重要資訊。權杖通常看起來像這樣:
此權杖中包含兩個關鍵資訊
- 租用戶 ID - 告訴 API 此呼叫應前往哪個租用戶空間
- 使用者 ID - 識別呼叫者的使用者身分
如果沒有此資訊,權杖會被拒絕,並且 API 呼叫會被送回。
此資訊由身分提供者產生,具體來說是 OAuth。 這是讓我們在 Web 介面中登入 Cloud 的同一個提供者。
在何處可以找到權杖?
在 Cloud 介面中您的個人資料設定或「管理雲端帳戶」區段下可以找到權杖。如果租用戶空間有 Automation 訂閱,API 選項會出現在左側功能表的底端。
哪些應用程式使用權杖?
雖然進行 API 呼叫的所有應用程式最終都會使用權杖,但僅有像 Insomnia 或 Postman 等專用應用程式才會明確定義權杖。
Web 應用程式是針對呼叫 API 並與其互動而建置的自訂介面,它使用 OAuth 呼叫來建立登入對話。從本質上說,這會在 OAuth 驗證使用者身分後產生存取權杖,其行為與對 API 的任何其他呼叫非常相似。
如需不同應用程式類型的驗證如何使用以及有何差異的更多資訊,請參閱「Cloud REST API 應用程式類型」。
關於本機印表機和權杖的特別注意事項
若要使用特定用戶端系統上的印表機,用戶端必須至少登入 Cloud 一次以建立連線。如果您從 Cloud 本身的列印對話方塊中安裝 Print Gateway,則此連線設定會自動完成。
如果您透過安裝程式安裝 Print Gateway,而不是透過 Cloud 的列印對話方塊,並且沒有登入 Cloud 來設定 Print Gateway,則需要有一個特殊權杖來允許 Print Gateway 與 Cloud 通訊。
此特殊權杖位於 Print Gateway 設定的頂端。
僅當用戶端系統從未登入 Cloud 來設定 Print Gateway 時才需要此權杖。如果用戶端已登入或已直接從列印對話方塊安裝 Print Gateway,請繼續使用 Web 介面的 Cloud 設定中提供的存取權杖。