为了方便客户调用 OpenAPI, 提供了 OpenAPI SDK, 其主要功能是提供了对签名过程和复杂查询参数的包装。SDK 已经在 Github 上开源,建议使用Github 源码的方式。基本使用流程:
bc
来指一个RangersClient实例)ak = '{使用AK替换}' sk = '{使用SK替换}' # 海外使用非中国区的地址;私有化,需要制定下私有化的finder服务域名,请参考 “OpenAPI 概览”的服务地址说明。 url = '{使用非中国区或者Finder服务域名替换}' bc = RangersClient(ak, sk, url=url) # 调用具体的接口 bc.request("${path}",...)
相关接口说明(具体的方法名称在不同的语言上会有命名格式的区别):
bc.data_finder("${path}", ...)
, 相当于 bc.request("/datafinder/${path}", ...)
,即在path前,加上一个/datafinder的context-pathbc.data_rangers("${path}", ...)
, 相当于bc.request(/datarangers/${path}", ...)
,即在path前,加上一个/datarangers的context-pathbc.data_tester("${path}", ...)
, 相当于 bc.request("/datatester/${path}", ...)
,即在path前,加上一个/datatester的context-pathbc.data_profile("${path}", ...)
, 相当于 bc.request("/dataprofile/${path}", ...)
,即在path前,加上一个/dataprofile的context-pathbc.data_tracer("${path}", ...)
, 相当于 bc.request("/datatracer/${path}", ...)
,即在path前,加上一个/datatracer的context-path建议后续都使用bc.request
接口。
另外,OpenAPI 还提供了查询 DSL Builder,具体接口参考源码 API 说明。
String ak = "xxx"; String sk = "xxx"; // 海外和私有化需要指定url地址, 可以参考 “OpenAPI 概览” String url="{使用非中国区或者Finder服务域名替换}"; RangersClient bc = new RangersClient(ak, sk, url);
Python SDK 软件包的形式下载后在shell执行以下命令完成安装:
# python需要3.7及以上版本 pip install rangersdk-${version}.tar.gz
from rangersdk import RangersClient ak = 'xxx' # ak sk = 'xxx' # sk bc = RangersClient(ak, sk) # 海外和私有化需要指定url地址, 可以参考 “OpenAPI 概览”, url = '{使用非中国区或者Finder服务域名替换}' # 注意这里传参数,一定要写成 url=url bc = RangersClient(ak, sk, url=url)
ak = "xxx" sk = "xxx" bc = new RangersClient(ak, sk) // 海外和私有化需要指定url地址, 可以参考 “OpenAPI 概览” url = '{使用非中国区或者Finder服务域名替换}' bc = RangersClient(ak, sk, url=url)
var ( ak = "xxx" sk = "xxx" ) bc := dslcontent.NewRangersClient(ak, sk) // 海外和私有化需要指定url地址, 可以参考 “OpenAPI 概览” url = '{使用非中国区或者Finder服务域名替换}' bc := dslcontent.NewRangersClientWithUrl(ak, sk, url)
ak = "xxx"; sk = "xxx"; $bc = new RangersClient($ak, $sk); // 海外和私有化需要指定url地址, 可以参考 “OpenAPI 概览” $url = '{使用非中国区或者Finder服务域名替换}' $bc = new RangersClient($ak, $sk, $url);