《釘釘應用開發者速成手冊》之“如何調用釘釘API——使用API Explorer”

步驟一：建立應用

1. 使用釘釘開發者賬号登入 開發者背景 ，在企業内部下，選擇小程式，然後單擊建立應用。

   

2. 填寫應用名稱、應用描述，選擇應用圖示，最後單擊确定建立。

   

應用建立完成後，在憑證與基礎資訊頁面，複制應用的AgentId、AppKey和AppSecret備用。

1. 選擇開發管理，單擊修改，完成以下配置：

• • 伺服器出口IP：輸入調用釘釘服務端API時使用的IP即企業伺服器的公網IP，多個IP請以","隔開，支援帶一個*号通配符的IP格式。

    說明

    伺服器出口IP需要填寫開發者自己的公網出口IP，可通過

    工具 進行檢視。

  • PC端首頁位址（可選）：輸入在PC端釘釘工作台上打開本應用的位址。連結位址必須以http或https開頭。

    如果未填寫，在釘釘PC端工作台點選應用圖示時，會提示“電腦版暫不支援顯示，請用手機釘釘掃描下方二維碼檢視”。隻能在手機釘釘用戶端使用該應用。

  • 管理背景位址（可選）：輸入組織管理者在 釘釘管理背景 通路該應用的位址。

1. 選擇權限管理，然後單擊添加接口權限，

   

2. 選擇待辦事項的接口權限，最後單擊确認。

   

步驟二：發起待辦

通過以下步驟，使用API Explorer工具完成發起待辦：

1. 在開發者背景的首頁打開 API Explorer 。

   

2. 擷取企業憑證access_token。通過調用

   /gettoken

   接口擷取企業憑證access_token，擷取步驟如下：

1. 1. 選擇應用類型為企業内部應用。

• • • 企業内部應用：目前API接口僅限于企業内部調用。
    • 第三方企業應用：目前API接口僅限于第三方企業調用。

      

1. 1. 依次選擇左側擷取憑證，然後選擇擷取企業憑證。

      

   2. 填寫appkey和appsecret，然後單擊發起調用。

• • • appkey：已建立應用的AppKey。

    • appsecret：已建立應用的AppSecret。

      API Explorer右側會直接生成對應的接口demo，可以選擇SDK下載下傳，也可以選擇檢視文檔，和官網文檔一模一樣。右側顯示調用結果成功之後，請複制傳回結果access_token的值，用于後續的使用。

      

1. 擷取使用者userId。通過調用

   /user/listsimple

   接口擷取使用者userId，擷取步驟如下：

1. 1. 單擊左側通訊錄管理，然後選擇查詢部門使用者簡易資訊接口。

      支援中英文模糊搜尋。

      

   2. 填寫相關參數資訊，然後單擊發起調用。

• • • access_token：已生成的access_token。
    • dept_id：部門ID，根部門ID為1。
    • cursor：分頁查詢的遊标，最開始傳0。

    • size：分頁長度。

      右側顯示調用結果成功之後，請複制傳回結果中對應使用者的userid的值，用于後續的使用。

      

1. 點選左側的待辦任務子產品，選擇新增待辦事項，填寫待辦事項内容，單擊發起調用。

• • access_token：已擷取的access_token。
  • userId：已擷取的userId。
  • create_time：待辦時間。
  • title：待辦事項的标題。
  • url：待辦事項的跳轉連結。

• • • formItemList：表單清單。

• • • • title：表單标題。
      • content：表單内容。

調用成功後，在待辦中會顯示對應的待辦任務，如下圖所示：