使用开放 API
友好速搭开放了 20+ API,开发者可以通过调用 API,来实现业务功能定制。
在访问 API 前,需要通过 OAuth2 获取授权:
访问 API 时,请求的 Header 中,需包含名为X-API-ACCESS-TOKEN
的参数,值就是授权获取的 access token。
开放 API 完整网址,由以下三部分组成:
- 根网址:
https://api.youhaosuda.com/
,仅支持 HTTPS - API 版本标识,目前是
v1
- 资源实体名称,即全部 API 列表中的实体的英文名
以获取店铺信息为例,完整的 API 地址为:https://api.youhaosuda.com/v1/shop
。
在 OAuth2 授权过程中,或者访问 API 时,遇到错误,请参考错误码说明。
对于大部分 API,只是常规的 REST 调用,但对部分 API,使用方式,不止 REST 调用,有更多用法,也会有更多可能。详情查看特殊 API 介绍。
除了开放 API 以外,还有一些开放接口,无需经过 OAuth2 授权,就可以使用,请查看其它开放体系。