iT邦幫忙

2024 iThome 鐵人賽

DAY 26
0
Software Development

想要工作更輕鬆? 跟著我一起用 Power Automate 自動化吧!系列 第 26

API 探索之旅:如何通過 Microsoft Graph Explorer 獲取重要資訊

  • 分享至 

  • xImage
  •  

💡 在本文章你將學到:如何利用微軟 API 測試 UI 工具找到指定資訊

前言


你有曾經在尋找 Teams Group ID, Channel ID, ShaePoint Comment 詳細資料或者任何感覺應該有留下資訊,但就是苦無線索找到相關資訊的時候嗎?如果有,那你不孤單,這些都是我在工作過程遇到的煩惱,當時在網路論壇看到網友分享了 Microsoft Graph Explore,彷彿找到救星。然而他是個我完全沒使用過的工具,雖然知道可以解決我的煩惱,但如果不曉得如何使用他,也是徒勞無功,因此本篇文章將會跟大家分享利用它。

內文


它是什麼?它能做什麼?

如果你知道 Postman,那你應該可以很快知道 Microsoft Graph Explore 的用途,它就是微軟專用的 Postman。那如果不知道 Postman,這邊從頭跟你介紹

這是它的網址以及介面

https://ithelp.ithome.com.tw/upload/images/20241010/20168562AKp0lbizAA.png

  1. 左方選單 - 透過選擇或者關鍵字搜尋找到一些通用的 API,當然,如果你知道它的結構,也可以自行編輯成左方選單沒出現的 API 取得你要的資料

  2. API 連結以及呼叫模式 - 在這邊你可以利用選擇好或者制定好的 API Link 以及呼叫模式選擇完後進行測試。

    📙 呼叫模式:大致分為 POST, GET, PUT/PATCH, DELETE,而如果對比資料庫操作

    • GET = read:這是最常使用的模式,主要是用來查詢 API 所得畫面的相關資料,例如 Teams 某個群組的某則訊息、群組 ID 等等
    • POST = create:當你需要透過 Power Automate 自動建立某個動作,如發文的時候,可以可以利用與 Microsoft Graph Explore 的互動檢視發出後的狀況與訊息預覽
    • PUT/PATCH = update:如果你有資料需要更新,就需要這兩個呼叫模式。兩者最大差別在於 PUT 是整筆紀錄更新,PATCH 可以做到部分更新。
    • DELETE = delete:這可以說是權限最大的動作,因為她有權力將伺服器裡的紀錄刪除,因此使用時需要多加留意。
  3. 獲得個人帳號權限:如果你要尋找的資料是需要權限的,例如想要取得自己所加入的 Group ID、Team 裡 Channel ID 等等,那你會需要登入後才能取得

  4. 設定權限:這通常是與第 3 點一起執行,當你登入後,你會需要告訴 Microsoft Graph Explore 要給予他到什麼程度的權限,而如果你只是單純想要取得 Group ID、Team 裡 Channel ID 這樣的資訊,那選擇 Chat.ReadBasic 就已經足夠了

  5. Response Review:這邊就是你透過 API 所取得的資料,當你要挖寶時,也就是需要從這裡尋寶,他的資料格式為 Json,因此你至少要能理解它的結構後才能快速找到結果。

小結:他不需要你撰寫程式,只需要你能理解呼叫模式、API 結構、json 格式的皮毛認識。

如何使用?

有時候你透過 Power Automate 會在 ⚡ 突然找不到某個 Group,這時候我們就是需要自行找到他的 ID 貼上,那這時候 Microsoft Graph Explore 就派上用場了。

首先你可以先嘗試以各種關鍵字在左方選單查詢看看,也許你會利用 teams, chat,最後會從 chat 這個關鍵字找到「list member of a chat」,點擊後隨即看到下方圖片的提示,Bingo,這才是我們真正要的 API ,將其複製後放到 API 執行框,並且記得改為 GET,你就能在 Response Preview 得到結果

https://ithelp.ithome.com.tw/upload/images/20241010/20168562y52ihpOvUg.png

接下來我們一起解讀 Response Preview 的 json,如果你的電腦是正常的,下方箭頭是可以看到 🔽 這樣的號誌,你可以縮放,透過這個動作可以觀察出哪些紀錄是同一階層的,透過階層候你會發現我畫了大括號的地方就是一串串群組的底層訊息,而其中 id 就是群組 ID,恭喜!我們抽絲剝繭後已經得到結果了!

https://ithelp.ithome.com.tw/upload/images/20241010/201685629bvtE2mg0l.png

後話


這個工具對我而言充滿很大意義,這是我第一次接觸 API 測試工具,從裡面挖寶然後找到寶藏時,瞬間覺得我原來懂這麼多(大笑),也因為我發現這是個水很深的工具,因此特別分享給大家,希望大家在這個簡單的介紹可以快速掌握眉角並協助你得到你要的訊息。

列點摘要 by GenAI

  • Microsoft Graph Explorer 的功能:
    • 類似於 Postman,專為微軟 API 設計。
    • 提供 API 連結、呼叫模式(GET、POST、PUT/PATCH、DELETE)和獲得個人帳號權限的功能。
    • 使用者可以設定權限來獲取所需資料。
  • 如何使用 Microsoft Graph Explorer:
    • 說明如何查詢 Teams 和 Chat 的相關 API。
    • 提供具體步驟來獲取所需的 Group ID 和 Channel ID。
    • 解釋如何解讀 API 回應中的 JSON 格式資料。

上一篇
將 Forms 寫在 Teams,並且用關鍵字呼叫?Adaptive Card 應用 -2
下一篇
Switch vs. Condition:Power Automate 中的條件處理比較
系列文
想要工作更輕鬆? 跟著我一起用 Power Automate 自動化吧!31
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言