提交API

最后更新于:2022-04-02 08:16:13

如果你有自己的API接口,可以提交给官方来对接纳入`ThinkAPI`服务,并尽量遵守官方的统一API接口规范。 ## 接口规范 提交的接口尽量满足如下规范(个别情况可以由官方二次封装处理,如果是API供应商则由我们对接处理,不需要按下面规范): > 统一使用`JSON`格式返回数据; > 返回数据主体包含`message`、`data`和`code`三项; > `code`返回0表示接口调用成功; > 接口返回的业务数据放入`data`数据中; > 尽量支持使用`HTTPS`请求; > 支持异常处理,调用失败支持错误信息(或者错误码)返回; > 付费接口尽量采用单独字段返回计费与否信息(或者code返回0表示计费); > 接口授权建议使用`key`和`secret`两个属性标记 > 接口传参建议使用驼峰命名,例如`orderId`而不是`order_id` ## 提交接口 ### 第一种:提供API接口 如果你有现成的API接口可以在线调用的,可以直接提供已有API接口地址。 接口提交请发邮件至 `thinkphp@qq.com`,并提供如下接口资料(可以参考现有的API接口): > 接口名称(25字以内); > 接口描述(100字以内); > 接口图片(250*250); > 请求地址及请求类型; > 请求参数和返回数据(参考已有的API文档); ### 第二种:接口服务平台 如果你是接口服务商(或平台),有大量接口需要提交对接的,我们会安排专人进行对接测试,无需你们做任何的调整,可直接联系微信`topthink`咨询商务及对接事宜。 无论选择何种方式都可以享受接口的调用分成机制(按实际调用次数计算,免费接口除外),详情咨询微信`topthink`。官方会对提交的接口进行测试及评估,但可能由于种种原因无法保证一定能收录您提交的接口。 >[danger] 如果是收费接口请提供一定数量的测试次数便于官方对接测试,由于稳定性原因,暂不支持个人付费接口的接入。
';