REST API/概览

REST API 概览

了解智慧芽开放平台 REST API 架构基础

API 架构

智慧芽开放平台提供遵循行业标准规范的 RESTful HTTP API。所有接口使用可预测的资源导向 URL，接受 JSON 编码的请求体，返回 JSON 编码的响应，并使用标准 HTTP 响应码和鉴权方式。

API 专为高性能和高可靠性设计，企业客户的平均响应时间为 45ms。

基础 URL

所有 API 请求应发送至以下基础 URL：

https://connect.zhihuiya.com

Note: 所有 API 请求必须使用 HTTPS，HTTP 请求将被拒绝。

API 版本

API 版本包含在 URL 路径中，当前稳定版本为 v1：

https://connect.zhihuiya.com/search/patent/query-search-count

我们在主版本内保持向后兼容。重大变更将在新主版本中引入，并提前通知。

请求方法

API 使用标准 HTTP 方法执行操作：

GET

获取资源

用于获取数据而不修改服务器状态。GET 请求是幂等且可缓存的

POST

创建或查询资源

用于创建新资源或通过请求体执行复杂查询。大多数搜索接口使用 POST 以接受详细的查询参数

PUT

更新资源

用于更新现有资源。PUT 请求会用提供的数据替换整个资源

DELETE

删除资源

用于删除资源。DELETE 请求是幂等的

内容类型

所有请求和响应均使用 JSON 格式。请始终包含以下请求头：

请求头
Content-Type: application/json
响应头
Content-Type: application/json; charset=utf-8

下一步

了解 API 基础知识后，请继续阅读以下指南，学习请求格式、响应结构和错误处理。