跳至主要內容
BANK API

說明如何透過 API 和 Property BANK Server 做溝通

BRICKS TOOLS avatar
作者:BRICKS TOOLS
3 年前已更新

此教學涵蓋將說明如何找到 BANK 的控制 API 以及相關的詳細文件查詢處。


在開始使用 API 之前,先說明 BRICKS 的 API 皆以 GraphQL 格式做溝通,使用前需了解 GraphQL 的相關語法。


🕐 此篇教學操作預計花費時間:2~3分鐘

  • 步驟一『 進入 BANK 的 Manage Keys 頁』

    點擊 [ BANK ] 頁籤,並點擊左下角的 [ Manage Keys] 進入編輯頁。

    Find Manage Keys position

  • 步驟二、『在 Key Management 的說明中找 API 連結』

    點擊 Key Management 右方的 [ ? ] 並在展開文字中找 [ API Explorer ] 連結。

    在前往 API 頁面前,先將下方括號 { } 內的 Code 複製下來。

    Get BANK API Explorer link and Copy Header code

  • 步驟三、『展開 API 頁面中的 HTTP HEADERS 內容 』

    點擊頁面下方的 [ HTTP HEADERS ] ,在展開的空間中,將上一步驟複製的程式碼貼上。

    Expand HTTP HEADERS Space

  • 步驟四、『返回 Controller 新增 Key 給 API 使用』

    點擊下方 [ Generate Key used by Update Page ],並在新增出來的 Key 列表中點擊 [ Copy Key ] 複製 Key。

    Generate a key to access BANK API

  • 步驟五、『將複製的 Key 貼上取代程式碼中的 Your_Key』

    選取程式碼中的 [YOUR_KEY],並將前一步驟複製的 Key 貼上(注意!請保留" " 符號)。

    Paste your key into header

  • 步驟六、『查閱 API 頁面中的 Doc 及 Schema 』

    點擊頁面右側的 [ Doc ] 查閱 API 支援項目 及 [Schema] 查閱資料結構

    Check Doc and Shema to write your API code

  • 步驟七、恭喜已經可以開始透過 BANK API 和 Property Bank 進行溝通了

    詳細 API 使用方式請參照頁面中的 [Doc] 內容,資料結構請參照頁面中的 [ Schema ] 內容。


    下一小節將說明 的查詢方式。

    若需要任何幫助,歡迎點擊右下角的對話圖示詢問,我們會盡快回覆您的問題

是否回答了您的問題?