API目录知识产权机构指南
让您的API易于查找
本指南介绍知识产权机构如何通过知识产权用API目录提供其API。
本指南介绍知识产权机构如何通过知识产权用API目录提供其API。
根据知识产权机构提供的开放式API规范（OAS）文件，API目录可以自动捕获这些API。通过采取以下步骤，可以确保将您的API纳入目录。
1.为您的API创建OAS文件
首先，请为您的API创建一个OAS文件，需满足以下关键要求：
OAS文件的最低数据标准
下表列出了OAS文件所需的最少字段集。
请注意，根据 Swagger的《开放式API扩展规范》提供的指导，下面提供了用“x-”标注的OAS扩展字段。
如果无法为模板中的定义字段提供值，则在API目录中将这些字段指定为 “manual entry” （手动输入）。未来的更新将要求在OAS文件中添加扩展模式，以避免手动编辑。
| OAS 字段 | 数据类型 | 说明 |
|---|---|---|
| openapi: | String | 所用的开放式API规范版本（建议使用3.0.x） |
| Info Object: | ||
| - title: | String | API名称 |
| - description: | String | API说明（最好采用对用例加以说明的格式，例如：本应用程序接口提供对[功能]的访问，以便用户可以[操作]）。 |
| - version: | String | 用于API的OAS文件版本。建议使用格式1.0.1 |
| - x-oas-url: | String | 可下载OAS文件的页面的URL链接（这将使自动抓取工具能够定期检查该页面，以查看您对OAS文件所做的任何更新） |
| - x-product-page-url: | String | 您网站上对API进行说明的产品页面的URL链接（这可确保API目录的用户能够直接转到其所寻找的API） |
| - x-ip-domain | Array[String] | 列出与该API功能相关的所有知识产权领域：专利、商标、工业品外观设计、版权、地理标志、植物品种保护、集成电路布图设计 |
| - x-service-type | Array[String] | 列出API可以提供的所有服务类型：帐号管理、申请管理、通信、公布、缴费、组合管理、注册、搜索、翻译（有关每种服务类型的详细说明，请参见下文） |
| - x-content-type | Array[String] | 列出API可以提供的所有内容类型：摘要、著录项目数据、引文数据、权利要求、分类、法院判决、说明书、同族数据、全文、法律状态数据、许可情况数据、局方通知数据、缴费相关数据、术语数据（有关这些内容类型的详细说明，请参见下文）。 |
| - x-content-language | Array[String] | 以ISO 639-1 set 1格式列出API可以响应的所有内容语言，用逗号分隔。 |
| - contact | Contact Object | |
| Contact Object: | ||
| String | 为API而联系的团队的电子邮件 | |
| - name | String | 机构名称 |
| - URL | String | 机构API目录网站的主页URL或开发人员的门户网站 |
| 路径对象： | Path Item Object | 保持各个端点及其操作的相对路径。路径会被附加到服务器对象的URL上，以便构建完整的URL |
| /(for each path...) | ||
| - summary: | String | 字符串摘要，适用于该路径中的所有操作 |
| - get/put/post/delete | 关于该路径上GET/PUT/POST/DELETE操作的定义 | |
| - responses | Responses Object | |
| -- HTTP Status Code | Response Object | |
| --- description | String | 对响应的说明 |
| --- content | Map [String, Media Type Object] | 内容类型响应格式，例如：application/json或application/pdf等 |
2. 发布OAS文件
用静态URL在您的网站上发布OAS文件。此外，还要确保没有其他抑制因素会阻止直接扫描OAS规范。例如，将规范作为ZIP文件发布。
重要提示：如果无法在初始OAS文件中包含OAS URL或API产品页面URL，请记得用上述标注了“x”的这些OAS字段更新OAS文件，然后将其作为新版本重新发布。不要忘记更新版本，以表明已作出这些更改！
3. 与国际局共享OAS文件URL
将OAS URL通过电子邮件发送给产权组织国际局。所有其他必需信息将使用OAS文件中提供的详细信息自动抓取。
4. 收到新的API条目后进行验证
完成上述第3步后，您将收到一封电子邮件，其中包含API的详细信息。
在该电子邮件中，如果必填字段不正确或空白，请将相关数据添加到OAS文件中并重新发布，然后再重新发送给国际局。
注：请定期更新OAS文件，以包括所有建议的数据字段，从而保持“single source of truth”（单一真实来源）。这样可确保一致性并减少手动更新。
API目录的可用筛选器
下表概述了可用的筛选器。可同时设置一个或多个筛选器。
| 筛选器标签 | 功能 | 选项 |
| 知识产权领域 | 根据API返回的知识产权内容类型进行筛选 |
选择以下一项或多项：
|
| API服务类型 | 根据API提供的服务类型或功能进行筛选 |
选择以下一项或多项： 为创建和维护用户帐号提供的服务。 为提交知识产权申请提供的服务，包括创建和提交知识产权申请。 知识产权局与相关知识产权所有者之间的通信，包括与申请人或其代理人关于审查意见通知书的通信。例如，与审查或费用有关的通信。 公布各种数据，如知识产权申请公布、法律状态数据、法院判决数据、摘要、引文数据、分类数据、全文数据…… 各种费用的缴费服务，如申请费和续展费。 为知识产权所有者/注册人或其代理人管理知识产权组合提供的服务。 提供关于知识产权申请的公开信息的服务，包括程序方面的详情。 根据特定查询（如关键词搜索或申请编号搜索）检索信息的服务。 知识产权文件或数据的翻译服务。 |
| 内容类型 | 根据API返回的内容类型进行筛选 |
选择以下一项或多项： 知识产权文件内容的简明归纳。 知识产权文件的描述性信息。通常包括标题、申请人或受让人、申请日期、公布日期以及其他相关的行政和程序详情。 专利文件对在先专利的引用（专利引文）或对非专利文献的引用（非专利文献引文）。 专利授予的保护范围，决定专利的覆盖范围。 知识产权文件根据其主题分为不同的类和小类。分类包括用于专利的 IPC/CPC分类、用于商标的尼斯分类、用于工业品外观设计的洛迦诺分类。 从涉及知识产权事务的法院案件中获取的有关法律裁决的信息和详细信息。 对发明的详细解释。 源于同一初始申请的相关知识产权文献的合集。 对专利申请或已授权专利中的发明或创造的完整、详细说明。 某一特定知识产权申请的当前法律状态，包含或不包含该知识产权申请的历史相关法律状态事件；或者在给定时期内，如给定的某一周或某个月中发生的知识产权申请法律状态事件的数据集。鼓励主管局按照产权组织标准 ST.27、ST.61 或 ST.87 提供信息。 与知识产权许可情况有关的数据。 与局方通知有关的数据，如检索报告、审查结果（如驳回或授权决定）、对局方通知的答复（如修改或论证）或相关管理信息（如申请到期日或缴费）。 与缴费相关的数据，如货币种类。 知识产权领域使用的特定术语和定义。 |
| 机构 | 根据提供API的机构进行筛选 | 选择一种或多种可用的机构。 |
| 响应语言 | 根据API返回内容的语言进行筛选 | 选择一种或多种可用语言。 |
| 响应格式 | 根据API返回内容的文件格式进行筛选 |
选择以下一项或多项：
|
| API协议 | 根据API是REST还是SOAP筛选API |
选择REST或SOAP：
|
| API操作 | 根据API提供的可用操作筛选API |
选择以下一项或多项：
|