Page tree
Skip to end of metadata
Go to start of metadata

此文档集,综合描述和介绍了如何使用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_hostnameapi.trustocean.com
service_typessl
version

v2

api_function_name请参看每个API方法详细页面说明

构造举例,获取证书产品列表:  https://api.trustocean.com/ssl/v2/getProductList

身份验证

您调用的每个API都需要进行身份验证才可以获得正确的API响应。身份验证是指您需要在每次调用API时,除了传递相关API的业务参数,还需要传递对应的身份验证参数如下:

参数名称类型备注
usernamestring和您的TRUSTOCEAN登录一样,是一个合法的邮箱地址
passwordstring不是您的TRUSTOCEAN登录密码,您必须从TRUSTOCEAN控制台的 代理商→API设置 菜单中进入到设置页面来生成用于访问API的 API Token. 这里需要填写的 password 就是指 API Token.

未传递正确的身份验证参数的API访问将会收到错误返回。

响应格式

所有的响应请求都是一个 application/json 的字符串。您可以使用各类字编程语言进行转换和访问。

捕获错误

所有的API请求成功与否都将用响应返回的 status 字段进行标记, status='success'表示请求成功, status='error'表示请求出现错误,下面是一个错误信息的构成举例:

错误信息举例
{"status":"error","error_code":99001,"message":"error message goes here"}

您也可以参照各API版本的错误代码列表,详细了解错误的类型和数据问题所在。

  • No labels