《钉钉应用开发者速成手册》之“如何调用钉钉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：表单内容。

调用成功后，在待办中会显示对应的待办任务，如下图所示：