# Postman模版使用说明
## 简介

Lark的OpenAPI开放能力基于Restful接口对外提供服务，为了方便开发者快速体验和测试各类接口，我们提供了第三方开发调试工具Postman的接口模板，下文将描述如何利用Postman工具来调试Lark的OpenAPI接口。 warnning
特别提示：  
- 创建账号时填写的信息为Postman应用中的账号信息，与Lark账号无关，请注意保护您的个人隐私。
- Postman是一个第三方开发调试工具，请使用测试环境APPID和Secret进行操作，保障生产环境数据安全，详情请参考该产品的[用户协议](https://www.postman.com/legal/terms/)和[隐私政策](https://www.postman.com/legal/privacy-policy/)。

## 第一步：导入离线模板库
> 下载 Postman工具并导入LarkOpenAPI模板库，Lark开放平台将不定期更新模板库文件。

**1.下载Postman工具**

你可以从[https://www.postman.com/downloads/](https://www.postman.com/downloads/) 下载postman工具并完成安装；

<br>
**2.导入LarkOpenAPI模版库**  

下载[压缩文件](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/0e4b8bb6de7902f89e4f6b8a8362b8e0_xFcMzSL1nQ.zip)并解压到本地；  
在Postman中新建一个空白的Workspace，可以选择Personal类型：

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/8bcc25416531cba602d7fa4e8d97bc2d_wTDPmTkS4k.png?lazyload=true&width=1724&height=1452)

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/07e260be5bcc8e23736eb1f687bd2916_nN2dhLKf3d.png?lazyload=true&width=1730&height=1454)

导入下载的接口模版 `Lark Open Platform.postman_collection.json` 和 环境变量配置模版文件，Larksuite环境使用`lark-demo.postman_environment.json`，如下图所示:

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/c3478b7ffcfb1135de664275356c49fb_QBMmXGX6w0.png?lazyload=true&width=2788&height=1480)

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/a06a896857d014dff2caff5301326993_NHqli5ybdA.png?lazyload=true&width=2786&height=1476)

## 第二步：修改自己的环境变量

从开发者后台找到自己的应用，并拷贝`App ID`和`App Secret` 并设置到环境变量中，如下图:

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/094c857b095d5b3ed54160ca78393527_x8LMpZ4Adp.png?lazyload=true&width=2556&height=866)

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/985241799a8d01d65ef1ec393a006915_AOo6ExragH.png?lazyload=true&width=1808&height=1298)

## 第三步：调试接口  
通过接口获取`access_token`，并将获取到的`access_token`设置到环境变量中，供其他常规接口使用，如下图所示；  

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/c0d32cb9b22e7929bdc99ed15dc7e763_DaQsOM43a2.png?lazyload=true&width=1888&height=1410)

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/74690651e79091aacbb0c4f7d1589de7_hAR1h7YYtJ.png?lazyload=true&width=1900&height=1422)

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/e1ba4c4c79ac4c6dddba1a4ce7bafa9b_piIoZ2Wkpm.png?lazyload=true&width=1820&height=1416)

在每个接口的调试面板右侧可以看到对应的文档，里面会有对应的接口文档地址和成功请求的Success Response Sample等信息，如下图：

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/0a0efb9d0ff54303466ff081452f8a58_4BCqOVGwhm.png?lazyload=true&width=1556&height=1428)

## 第四步：寻找官方帮助，提供有效信息  
当在使用该接口调试遇到问题需要寻找官方帮助时可以[咨询客服](https://applink.larksuite.com/client/helpdesk/open?id=6626260912531570952&extra=%7B%22channel%22:14,%22created_at%22:1614493146,%22scenario_id%22:6885151765134622721,%22signature%22:%22ca94c408b966dc1de2083e5bbcd418294c146e98%22%7D)，并反馈有效排查信息。

反馈时请提供如下信息以提高排查效率  

| 信息         | 示例           | 备注     | 
| --------- | --------------- | -------   | 
|请求URL|如：`https://open.larksuite.com/open-apis/im/v1/chats` |  |
|应用ID|如：`cli_a0fd0a733078900b`| | 
|请求ID X-Request-Id|如：`f4c72e68-5639-4491-808d-9f7dd30ab4af`|从响应体的Header中可获得，参考表下附图 |  
|错误信息 | 如：`{"code": 99991672,"msg": "No permission","data": {}}`| |

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/99f2885b61ef26a09855c6fe45d45492_0xa6xoslX2.png?lazyload=true&width=1170&height=1378)

## 第五步：直接使用postman中提供的SampleCode 
当我们在Postman中完成接口的调试之后可以直接在右侧 Code 菜单中找到各种语言的代码片段参考，如下图筛选了基于OkHttp的Java调用代码，直接将这部分的代码拷贝到你的业务代码中即可使用

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/39b6d906093c64b5da0a9889ede8bfe3_L3FygDUpAk.png?lazyload=true&width=2042&height=1182)

![image.png](//sf16-sg.larksuitecdn.com/obj/open-platform-opendoc-sg/f8ec22e41c93689335d2894c9ed24fdb_dtNg7QPtQf.png?lazyload=true&width=2024&height=1210)