收钱吧智慧门店开放平台接口文档
项目概述
本项目是收钱吧智慧门店开放平台的接入技术文档,旨在帮助开发者快速理解和对接收钱吧开放平台的各类API接口。
开放平台基于收钱吧智慧门店业务场景,在安全、合规、有序的前提下与相关合作开发者开展技术合作,为商家提供服务。
接入流程
- 项目制对接:本文档所提供的数据API对接采用项目制流程
- 提交申请:由业务接口人提交对接申请
- 技术支持:收钱吧将指派项目的技术接口人给予支持,包括:
- APIKEY的颁发
- 数据口径说明
- 对接细节问题解答
- 应用注册:开发者在开放平台注册自己的应用(当前未开放自助注册,请与商务联系申请注册)
- 商家授权:邀请商家进行授权,商家同意授权后,即可通过API获取商家授权的数据
文档结构
一、公共定义
| 文档 | 说明 |
|---|---|
| 概述 | 开放平台整体介绍 |
| 接入须知 | 接入流程和注意事项 |
| 名词解释 | 专业术语说明 |
| 应用管理 | 应用创建与配置 |
| 授权管理 | 商家授权流程说明 |
二、消息推送平台接口
消息推送平台是开放平台中,由开放平台主动发起调用第三方应用服务的一个通道,用于向应用推送订单变更等消息。
| 文档 | 说明 |
|---|---|
| 消息推送平台 | 平台整体介绍 |
| 接口要求和细节 | 接口调用规范 |
| 接口推送参数说明 | 请求参数详解 |
| 消息验签 | 签名验证机制 |
| 消息解密 | 消息解密方法 |
| 各业务消息参数说明 | 不同业务类型的参数说明 |
三、主动查询接口
业务的各类数据,需要第三方应用通过主动调用对应的查询接口来获取。
| 文档 | 说明 |
|---|---|
| 主动查询接口 | 接口整体介绍 |
| 通用接口要求和说明 | 通用调用规范 |
| 获取令牌(access_token) | 身份认证令牌获取 |
| 订单查询 | 订单数据查询接口 |
| 共同体统计数据查询(门店规模) | 门店规模统计查询 |
| 共同体统计数据查询(门店月度交易数据) | 月度交易数据统计 |
重要说明
- 当开放平台进行安全改造及接口升级调整时,开放平台会进行公告
- 开发者有义务在规定时间内整改接口,避免影响业务开展和商家经营
- 当前未开放自助注册,请与您的商务联系申请注册
技术支持
如有对接问题,请联系收钱吧指派的项目技术接口人获取支持。