开发指南总览
阅读指引:本篇是「开发帮助」的总览,帮助你快速建立对莲信开放平台的整体认识,并按需找到合适的文档入口。各主题的接口字段与调用细节,以「服务端 API」和「JSSDK」两个文档分类为准。
平台简介
莲信是面向组织协同办公的私有化即时通讯办公平台,提供即时通讯、组织通讯录、群协作与工作台等基础能力。
莲信开放平台将平台能力以标准契约开放给第三方系统:
- 服务端 API:基于 OAuth2 与 OpenAPI 的 HTTP 接口,供应用后端调用,覆盖应用凭据、用户授权、用户资料、素材、消息、组织目录、群应用与 Webhook 事件回调。
- 客户端 JSSDK:运行在莲信客户端内 H5 页面的 JS 接口,供前端调用,覆盖免登授权、界面控制、设备与位置、会话能力。
第三方系统以服务号应用形态接入:应用由平台管理员创建并授权,接入工作分为两部分——应用后端(调用服务端 API)与客户端页面(可选,部署 H5 并按需接入 JSSDK)。
能力一览
| 能力 | 说明 | 主要入口 |
|---|---|---|
| OAuth2 | 应用 Token、用户授权 code、用户 Token、刷新与撤销 | /oauth2/*、JSSDK getAuthCode |
| 用户资料 | 读取当前授权用户资料,下载短期头像资源 | GET /user/profile |
| 应用素材 | 上传文件、语音、视频、图片;下载当前应用素材 | POST /materials、GET /materials/content |
| 消息发送 | 应用向用户、组织节点、全员或已绑定群发消息;支持文本、素材、卡片、模板卡片;授权后可代发 | POST /messages/send、POST /messages/delegate_send |
| 组织目录 | 读取授权组织、成员与人员详情;按同步水位可靠同步 | GET /organization/* |
| 群应用 | 群添加应用后,同步群与成员,并以应用身份向群发消息 | GET /groups/* |
| Webhook 事件 | URL 验证、用户消息、卡片操作、组织与群变化、媒体下载 | webhook_url |
| JSSDK | config 初始化、getAuthCode 免登、界面控制、设备与位置、openChat/chooseChat |
页面引入 jsapi.js |
接入总体流程
开发者提交应用资料
→ 管理员创建应用、配置 Scope 与发布范围
→ 应用后端部署 Webhook 验签与验证响应
→ 管理员配置并验证 webhook_url
→ 交付 app_key / app_secret / sign_key
→ 应用后端完成 OAuth2 与 OpenAPI 联调
→ 管理员发布应用,用户在工作台使用
完整说明见《快速开始》。
文档地图
| 分类 | 篇目 | 说明 |
|---|---|---|
| 开发帮助 | 本套 8 篇 | 平台认知、接入流程、核心概念、常见问题 |
| 服务端 API | 服务端 API 概览 | 可用能力、按任务查找、请求限制总表 |
| 服务端 API | 创建应用与取得凭据 | 应用创建流程与凭据交付 |
| 服务端 API | 应用级 Token | client_credentials 获取与刷新 |
| 服务端 API | 用户授权 OAuth2 | Scope、H5 与 JSSDK 授权、用户资料 |
| 服务端 API | 素材上传与下载 | 素材类型限制与上传下载 |
| 服务端 API | 发送应用消息 | 消息类型、接收目标、代发、去重重试 |
| 服务端 API | Webhook 事件回调 | 验签、事件处理、媒体下载、幂等 |
| 服务端 API | JSSDK 配置与签名 | jsapi_ticket、config、受保护能力 |
| 服务端 API | 发布范围与资源边界 | 可见范围与数据维度 |
| 服务端 API | 组织目录同步 | 部门与成员可靠同步 |
| 服务端 API | 群应用与群数据同步 | 群生命周期与成员增量获取 |
| 服务端 API | Scope 映射与错误处理 | 接口映射、业务码、安全清单 |
| JSSDK | JSSDK 快速开始 | 引入方式、能力总表、config 初始化 |
| JSSDK | 授权与免登 | getAuthCode 获取授权码 |
| JSSDK | 界面控制 | 导航栏、菜单、浮窗、关闭页面 |
| JSSDK | 设备与位置 | 设备类型、当前群 ID、定位 |
| JSSDK | 会话能力 | openChat、chooseChat |
按任务查找
- 第一次接入:读本套《快速开始》《开发前必读》,再按《服务端 API 概览》的请求限制总表展开。
- 做免登:《身份授权》,配合《用户授权 OAuth2》与《授权与免登》。
- 发通知 / 卡片:《消息与素材》,细节见《发送应用消息》。
- 接收用户回复与事件:《消息与素材》的 Webhook 章节,细节见《Webhook 事件回调》。
- 同步组织架构或群数据:《目录与群数据同步》,细节见《组织目录同步》《群应用与群数据同步》。
- 在 H5 中调用客户端能力:《JSSDK 快速开始》及其余 4 篇 JSSDK 文档。
- 上线前检查:《开发前必读》的安全红线,以及《Scope 映射与错误处理》的安全清单。