API 管理常見問答 - TPIsoftware Documentation

FAQ

1. 平台使用權限

我們公司有不同 API 開發及管理部門，我要怎麼去區分?

digiRunner 提供於平台上創建組織層級架構。您可以根據需要輕鬆設置平台層次關係。此外，您還可以設置角色權限來管理各個級別的平台權限。

2. API 代理

我的 API 都是存在不同的 AP 伺服器，要怎麼統一做管理？

digiRunner 提供 API 代理服務。您可以通過 API url (http / https) 將您的 API 註冊到 digiRunner。或者您可以通過 Swagger 文檔將 API 註冊到 digiRunner，並讓 digiRunner 處理代理和管理事務。

3. API 加密

我的 API 沒有加密，digiRunner 能幫我做到嗎？

您可以通過 digiRunner 管理控制台將 JWE/JWS 添加到您的 API。此外，API 列表也可以查看 API 是否有 JWE/JWS 加密。

4. API 開關

我發現我有支 API 不安全或者是不需要了，要如何停止使用？

別擔心，透過 digiRunner 主控台的 API 管理介面，輕輕鬆鬆就能啟用/停用 API。

5. API 屬性群組管理

我的 API 服務屬性及安全性都不一樣，要怎麼做區分及授權？

digiRunner 提供 API 分組功能。您可以將相同種類或相同安全級別的 API 放入同一個組中。此外，您可以一次向您的 API 用戶端授權 API 群組(內含多支 API)，而不是一支一支授權，節省維運時間。

6. 格式轉換

我的API很舊，有的是XML有的是電文字串，也可以在digiRunner中管理嗎？

只要您的 API 是以web service的型式 (http / https)，就可以把您的API註冊到digiRunner，讓digiRunner做代理。此外，使用 digiRunner API Composer，就可以輕鬆進行格式轉換 ( EX: XML ↔ JSON)。

7. 後端系統介接

我有許多後端系統要介接，自己寫 code 廢寢費時，該怎麼辦？

digiRunner API Composer，內建多種系統節點 ( 如 MQ、SAP RFC等），不需從頭寫，只需透過簡單的拖放節點，讓你輕鬆快速設計與後端系統介接的 API。

8. API 授權

我的 API 核身授權方式都不一樣，能否透過 digiRunner 設定？

digiRunner 提供以下方式的核身授權，讓您輕鬆授權，再也不用為了不同的 API 授權方法傷腦筋。
- Public
- API Key
- OAuth 2.0 ( Client Credential / Password / Auth Code / Implicit )
此外，上述設定都能在 digiRunner 主控台的管理介面，一鍵完成。

9. API 測試

要怎麼確定讓 digiRunner 代理的 API 有在正常服務呢？

digiRunner 提供 API 測試功能。只要是透過 digiRunner 管理的 API (API 註冊 & API Composer) ，都可以透過管理介面來測試。除此之外，您也可以透過 digiRunner 來測試掛載在外部伺服器的 API 是否可以正常被呼叫。

10. API 報表

每日的 API 呼叫量那麼多，我要怎麼知道哪幾支 API 最受歡迎？哪個用戶呼叫最多次 API？

digiRunner 提供各式報表，您可以透過 digiRunner 管理介面，輕鬆查看或匯出 API 的使用統計報表、反應時間及用戶使用 API 的流量等。

11. API 明細查詢 (log)

我的某筆 API 交易似乎有點問題，我要怎麼去查看交易資料？

digiRunner 提供 API Log 查詢，讓您可以輕鬆查看指定的 API 交易明細。

12. API 代理安全

交給 digiRunner 做 API 代理安全嗎？

您可以放心讓 digiRunner 做 API 代理。 digiRunner 具備 WAF 防護功能，除此之外還有 IP 黑/白名單功能及流量控管。閘道安全及IP控管都幫您顧到了。

13. API 入口網

我想開放我的 API 給內部人員及外部合作伙伴，要怎麼做？

您可以公開您的 API 到 digiRunner API 入口網 ( Developer Portal)，且透過設定開放狀態，就可以輕鬆讓 API 在入口網查找及申請 API 使用授權。

14. 入口網管理

我可以管理 API 入口網嗎？

您可以透過 digiRunner 主控台管理以下Developer Portal 功能
- API 主題
- 常見問題
- 關於網站
- 網站地圖
- 公告維護
- Swagger 開放設定

FAQ