快速开始
注册账号
当前未开放自助注册。您需要通过PatSnap的帐号登录。登录成功后,您可以浏览接口文档,获取接口凭证和确认您的接口使用量。
接口凭证
如果您购买了接口的使用权限,登录成功后,跳转到
个人中心 页面。可以看到您的接口凭证是:Client ID 和 Client Secret 。您还可以在此页面上,监控到您的接口使用量情况。
权限令牌
1、通过
Client ID和
Client Secret,生成基于Base64编码规则的Authorization;
2、携带Authorization作为请求头,请求获得token;
3、请注意:token有效期为30分钟。
Client ID 是: b4562e4188asd4cb486a19c6971515c66
Client Secret 是: N1eOgd8sOk4z1vaWQfB18P4AbSk70lGs
你可以在代码中使用POST 方法获取权限令牌。
例如:
curl -X "POST" "https://connect.zhihuiya.com/oauth/token" \
-H "Content-Type: application/x-www-form-urlencoded " \
-u b4562e4188asd4cb486a19c6971515c66:N1eOgd8sOk4z1vaWQfB18P4AbSk70lGs \
-d "grant_type=client_credentials"
const request = require('request');
request.post(
{
// eslint-disable-next-line no-template-curly-in-string
url: 'https://b4562e4188asd4cb486a19c6971515c66:N1eOgd8sOk4z1vaWQfB18P4AbSk70lGs@connect.zhihuiya.com/oauth/token',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
form: 'grant_type=client_credentials',
},
(err, res, body) => {
if (!err) {
console.log(body);
} else {
console.log('error authenticate', err);
}
}
);
import requests
url = "https://b4562e4188asd4cb486a19c6971515c66:N1eOgd8sOk4z1vaWQfB18P4AbSk70lGs@connect.zhihuiya.com/oauth/token"
payload = "grant_type=client_credentials"
headers = {
"content-type": "application/x-www-form-urlencoded"
}
response = requests.request("POST", url, data=payload, headers=headers)
print(response.text)
public static void main(String[] args) {
String host = "https://b4562e4188asd4cb486a19c6971515c66:N1eOgd8sOk4z1vaWQfB18P4AbSk70lGs@connect.zhihuiya.com";
String path = "/oauth/token";
Map headers = new HashMap();
headers.put("Content-Type", "application/x-www-form-urlencoded");
Map requestbody = new HashMap();
requestbody.put("grant_type", "client_credentials");
try {
/**
* Important Tips:
* Please Download HttpUtils From
* https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/src/main/java/com/aliyun/api/gateway/demo/util/HttpUtils.java
*
* Please refer to the corresponding dependence:
* https://github.com/aliyun/api-gateway-demo-sign-java/blob/master/pom.xml
*/
HttpResponse response = HttpUtils.doPost(host, path, null, headers, null, requestbody);
System.out.println(EntityUtils.toString(response.getEntity()));
} catch (Exception e) {
e.printStackTrace();
}
}
得到的响应体如下:
{
"token": "token_example",
"token_type": "BearerToken",
"expires_in": 1799,
"status": "approved",
"issued_at":"1692347672874"
}
业务接口
在您获得权限令牌以后,您可以通过令牌来调用您购买的业务接口。
例如:您希望通过某个专利的唯一标识获取专利详情,你可以发起GET方法,并带上请求参数apikey和header信息X-PatSnap-Version和Authorization,其中apikey是您的客户端ID,X-PatSnap-Version为您希望请求的接口版本号,Authorization为权限验证内容,其组成为:Bearer [令牌]
例如:Bearer token_example(注意 Bearer 与令牌之间有一个空格)
版本号
服务使用X-PatSnap-Version头来指定返回的响应内容。
X-PatSnap-Version头采用以下格式:
{
"X-PatSnap-Version": "[API Version]"
}
[API Version] 代表请求接口的版本号。 例如:
{
"X-PatSnap-Version": "1.0"
}