此文档集,综合描述和介绍了如何使用API来控制您的账户,您可以通过API集成到其它第三方系统来管理您账户下的各类服务和产品。不同的API将独立完成特定的工作。
访问方法
所有的API请求参数都应该使用 POST 方法进行传递,并采用 application/x-www-form-urlencoded 进行参数编码。PHP环境下可参考CURL模拟表单POST请求。
访问地址
访问API之前,您需要我们是如何构造和定义API地址的:
API Endpoint 构造方法
https:
//{api_hostname}/{service_type}/{version}/{api_function_name}
|
特别注意,在以上构造方法中的 {api_function_name} 是大小写敏感的,您需要严格遵循API方法的大小写名称。当前可用的版本API服务信息如下:
构造参数
|
可用取值
|
---|---|
构造参数
|
可用取值
|
api_hostname | mall.okcert.cn |
service_type | jeecg |
version | okcertController |
api_function_name | 请参看每个API方法详细页面说明 |
构造举例,获取证书产品列表: https://mall.okcert.cn/jeecg/okcertController.do?getToken
身份验证
您调用的每个API都需要进行身份验证才可以获得正确的API响应。身份验证是指您需要在每次调用API时,除了传递相关API的业务参数,还需要传递对应的身份验证参数如下:
参数名称
|
类型
|
备注
|
---|---|---|
参数名称
|
类型
|
备注
|
token | string | 您必须从OKCERT控制台的API接口中调用getToken接口生成用于访问API的token来进行身份验证。 |
未传递正确的身份验证参数的API访问将会收到错误返回。
响应格式
所有的响应请求都是一个 application/json 的字符串。您可以使用各类字编程语言进行转换和访问。