幂简平台API录入标准

内容

一、概述
二、基本字段说明与要求
三、常见问题清单

一、概述

幂简集成平台是一个API信息聚合展示平台，用户可以将自己或互联网上发现的API资源分享到API HUB中，来共建我们的API社区。

个人用户可通过个人空间分享自己的API，或是分享从互联网上发现的API，并从中获取一份兼职收益。您可通过点击此处了解个人用户操作指南和兼职录入活动。

服务商用户可通过服务商空间，来分享您公司提供的API，并在API HUB进行一系列的营销活动。点击了解服务商操作指南。

本文将为您介绍在幂简平台分享API的基本录入标准，并给出一些优秀案例，以便您更好地把握API录入时的格式和内容，助您通过审核。

二、基本字段说明与要求

打开一个服务的编辑页面，可以看到左侧菜单中分为服务信息维护、API信息维护、HUB管理、设置这四部分内容，下面我们将分别介绍这几部分的功能、字段含义及录入要求。

注：本文只对录入标准进行说明，若想了解系统功能，请点击功能介绍查看。

1 API详情维护

该模块主要展示API的基本信息、服务功能介绍、优势、原理、应用场景、使用指南、常见问题解答等内容。用户通过浏览该模块，即可快速了解该API。

1.1 基本信息

该模块需要填写API展示必需的基本信息，释义与要求见下：

字段名称	含义	是否必填	录入要求
服务logo	API服务的图标，用在API HUB前台展示和识别	是	logo图片需清晰、准确、可识别，与API内容必须相关。若API无单独的服务logo，可使用API提供商的公司logo代替。建议尺寸：80*80。
服务名称	API服务的名称	是	服务名称与API的实际功能需一致，专用API需带上服务商名称前后缀，用以区分同类别的API。服务命名标准点此查看。
服务描述	API服务的基本描述	是	通过简短的几句话，描述清楚该API的功能用途及亮点。描述中需提及API服务的关键词，方便SEO。如果该API涉及某领域内的专用名词，需要在服务描述进行解释。服务描述标准点此查看。这部分录入时需要检查完善，不得一味粘贴。
服务分类	API服务在平台上的分类	是	服务分类需准确，符合大众认知，最多可选择三级。若某个API服务同时涉及多个类别，则选择相关度最高的。例如：AI作画应优先归类到【AI技术-AI绘画】，而不是【开发者服务-图像工具】。
采购链接	该API服务的产品落地页或采购页面网址	是	优先填写API的产品落地页或采购页，要求网址链接准确，点击后网页可以正常打开，录入时需带上http(s)前缀。若该API没有相关产品落地页，也可使用文档页链接。
在线应用地址	API服务功能的在线体验地址	否	若该API服务提供线上试用功能，可以填写试用链接，方便用户更好地理解该API。若没有则不要填。

1.2 产品介绍

1.2.1 概述

产品介绍为重点内容填写区域，整体要求如下：

可读性：文章整体图文结合，但要以文字为主，占70%；图片为辅，为了提高内容可读性与丰富度，方便用户理解。必要时可将图片内容提取出文字与配图单独录入，避免配图时图文内容重复。
官网内容完整、准确：官网存在的内容不可遗漏。录入时需理解服务，不要将各模块内容错录、混录。
必填项：必填项以官网内容为准，若没有则需使用AI工具生成，生成时需要挑选强相关内容，去除不确定、无中生有类的内容，例如“可视化界面”、“定制化服务”等；
选填项：选填项以官网内容为准，若没有则无需填写，不必AI生成。
图片格式：若无特殊录入样式，图片要求全部居中，大小合适。图片最小要能看清内容不模糊，最大不能占据整个屏幕。一般长方形图（例如头图）以1200-800为宜，比较方正的配图以500-800为宜。

详细内容如下：

字段名称	含义	是否必填	录入要求
什么是“XXX服务”？	简明扼要的服务定义、服务内容介绍、特征及特质	是	1.需要文字内容，要求直观，能说明产品介绍的是什么服务，不宜字数过少；不能只有图片； 2.需要头图，可截取服务页头图或官网头图（若图中有按钮需要去掉，下同），尺寸建议长方形为宜，不宜过高，需居中。
“XXX服务”有哪些核心功能？	服务的核心功能介绍	是	1.核心功能首以官网内容为主，不要遗漏； 2.若官网无相关内容，才可AI工具生成，生成时需要挑选强相关内容，去除不确定、无中生有类的内容，例如“可视化界面”、“定制化服务”等； 3.内容要求以文字为主，图片为辅。不可直接截图官网相关内容，需提取出文字，多条内容以1234序号排列；
“XXX服务”的技术原理是什么？	底层技术原理、工作原理、实现方法与流程	否	1.技术原理能首以官网内容为主，不要遗漏； 2.若官网无相关内容，不必填写； 3.内容要求以文字为主，图片为辅。
“XXX服务”的核心优势是什么？	服务的核心竞争力，为用户带来的提升	是	1.核心优势首以官网内容为主，不要遗漏； 2.若官网无相关内容，才可AI工具生成，生成时需要挑选强相关内容，去除不确定、无中生有类的内容，例如“可视化界面”、“定制化服务”等； 3.内容要求以文字为主，图片为辅。不可直接截图官网相关内容，需提取出文字，多条内容以1234序号排列；
“XXX服务”有哪些使用限制？	限制范围，使用条件等	否	1.使用限制首以官网内容为主，不要遗漏； 2.若官网无相关内容，不必填写； 3.内容要求以文字为主，图片为辅。
“XXX”API接口的能力有哪些？	核心接口清单 or 核心接口图示说明	否	需要列出接口清单，如下示例
在哪些场景会用到”XXX”API接口？	应用场景、应用案例	是	1.使用场景必须图文结合，样式可参考后文示例中的一种即可 2.优先官网的使用场景和配图，官网没有时可自行生成相关度高的内容，配图可直接百度相关性高的。
“XXX”API接口可以替换哪些服务商的API接口？	竞争对手及优势对比	否	以官网为主，尽量使用文字

1.2.2 样式示例

示例1

示例2

录入前：https://www.truora.com/en/truchecks

录入后：https://apihub.explinks.com/api/scd202405222718249d9249

示例3

示例4

示例5

示例6：接口能力

1.3 相关文档

该模块主要展示与API相关的文档类内容，例如使用指南、对接流程、常见FAQ等等。

相关文档的录入要求概述如下：

以官网为主，无遗漏：使用指南、对接流程、常用FAQ都需使用API服务商官网提供的官方内容。官网有则需要填写不得遗漏；若官网不提供，则无需强行生成或填写。
文字优先：录入内容需尽量以文字为主、图片为辅，保证文字覆盖率与可读性。必要时将图片中的内容提取成文字。
无需API文档：与API对接相关的接口文档可在【接口文档维护】处录入（暂不需要），无需在此录入。
内容通用性：若对接流程应为服务商下的通用流程，可在【店铺管理-对接流程】处填写，填写后服务商下的所有服务都会展示通用的对接流程。若是某服务单独的使用指南，可在该服务的对接指南处单独填写单独展示。
内容准确性：录入前需明确该内容是否属于使用指南或对接流程，不要录入不相关的内容。也要注意该内容是否属于该服务，不要错录成其他服务的。
可用链接：因使用文档篇幅形式有限，额外的扩展内容需在文字相关处加上链接，或在文档结尾处单独提供相关链接，例如：详细操作指南可见https://www.explinks.com/docs/instruction

1.3.1 使用指南（非必填）

使用指南为该服务专属的指导性文档。若是服务商下的通用性流程文档，请见下文【对接流程】。

使用指南通常包括以下方面内容：

（a）快速入门

环境准备： 说明需要准备的开发环境和工具。
认证方式： 详细描述获取和使用API密钥或令牌的步骤。
示例代码： 提供简单的示例代码，展示基本的API调用。
步骤流程： 使用平台或进行对接的指导流程。

（b）安全性

数据加密： 介绍API在传输和存储数据时的加密方法。
身份验证： 描述如何确保API调用的安全性。

（c）支持与反馈

技术支持： 提供获取技术支持的联系方式和渠道。
反馈机制： 说明如何反馈API使用中的问题和建议。
操作说明：给于一些平台的基本操作指导。

1.3.2 对接流程（非必填）

对接流程通常为服务商下的通用性文档，编辑后会展示在该服务商的所有服务下，无需重复多次录入。修改的位置在【店铺管理-对接流程】。

对接流程通常是指开发者将某个API集成到他们的应用程序或系统中的通用步骤，例如：

1.3.3 常见FAQ（非必填）

常见FAQ（Frequently Asked Questions）是指开发者在使用API过程中经常遇到的问题及其解答。这些问题涵盖了从初次使用API到复杂调用过程中可能遇到的各种问题。

常见FAQ的位置通常在服务页面底部，有时需在帮助文档里仔细寻找，不要遗漏。若官网没有，则无需填写。

常见FAQ有的独属于某个服务的问题，有的属于整个服务商下的通用FAQ。

服务专属FAQ：可在服务内【相关文档-常见FAQ】处编辑。
服务商通用FAQ模板：可在【店铺管理-FAQ模板】处编辑好通用FAQ模板，然后在每个服务中选择从模板添加，则无需每次重复录入FAQ。

服务专属FAQ示例：

服务商通用FAQ示例：

1.3.4 价格说明

需要在此处填写官网服务的详细定价介绍或截图。

注意：定价中，较为离谱的翻译，需要通过修改前端页面的方法再截图，或转为文字说明也可。例如，免费的翻译成自由的，起始价翻译为启动器等等……

此图片的alt属性为空；文件名为image-107-1024x680.png

2 接口文档维护

接口文档内容暂不需要录入，后续功能敬请期待。

3 HUB管理

3.1 上架与主推

录入服务最终结果是在API HUB前台上架展示。

服务通过审批后，需将通过的新版本设为主推版本（初次创建时，审核通过后自动主推），并点击上架后，服务最终才会正确展示在API HUB前台。

3.2 计价说明

3.2.1 适用范围

指该服务提供给哪种用户可用，一般默认个人&企业。如有特殊说明仅企业用户可用，需进行相应的勾选。

3.2.2 收费类型

定价一般可见于服务页，或官网专门的定价页。

人工报价：来源找不到价格信息时选这个。
免费：我们对免费的定义是可以白嫖的那种，例如每天限制调用10次，但是不限次数每天都能使用。有试用次数的不算免费（例如1个月给500次调用，过了一个月就不能用了，这种不算免费，算付费即可）。免费使用限制可填写类似“每月100次”。
付费：来源有明确价格的选择付费，单价一般按照最低价（例如20元/月起）；收费接口先不用选择；如果有套餐，则需要选是，然后截图或自建表格，将套餐价格录入；若套餐中含免费试用额度，可填写类似“0元/次起”、“7天试用”、“100次试用”等。