内容
- 一、概述
- 二、基本字段说明与要求
- 1 API详情维护
- 2 接口文档维护
- 3 HUB管理
- 4 关于我们
- 三、常见问题清单
一、概述
幂简集成平台是一个API信息聚合展示平台，用户可以将自己或互联网上发现的API资源分享到API HUB中，来共建我们的API社区。
个人用户可通过个人空间分享自己的API，或是分享从互联网上发现的API，并从中获取一份兼职收益。您可通过点击此处了解个人用户操作指南和兼职录入活动。
服务商用户可通过服务商空间，来分享您公司提供的API，并在API HUB进行一系列的营销活动。点击了解服务商操作指南。
本文将为您介绍在幂简平台分享API的基本录入标准，并给出一些优秀案例，以便您更好地把握API录入时的格式和内容，助您通过审核。
二、基本字段说明与要求
打开一个服务的编辑页面，可以看到左侧菜单中分为服务信息维护、API信息维护、HUB管理、设置这四部分内容，下面我们将分别介绍这几部分的功能、字段含义及录入要求。
注：本文只对录入标准进行说明，若想了解系统功能，请点击功能介绍查看。
1 API详情维护
该模块主要展示API的基本信息、服务功能介绍、优势、原理、应用场景、使用指南、常见问题解答等内容。用户通过浏览该模块，即可快速了解该API。
1.1 基本信息
该模块需要填写API展示必需的基本信息，释义与要求见下：
1.2 产品介绍
1.2.1 概述
产品介绍为重点内容填写区域，整体要求如下：
- 可读性：文章整体图文结合，但要以文字为主，占70%；图片为辅，为了提高内容可读性与丰富度，方便用户理解。必要时可将图片内容提取出文字与配图单独录入，避免配图时图文内容重复。
- 官网内容完整、准确：官网存在的内容不可遗漏。录入时需理解服务，不要将各模块内容错录、混录。
- 必填项：必填项以官网内容为准，若没有则需使用AI工具生成，生成时需要挑选强相关内容，去除不确定、无中生有类的内容，例如“可视化界面”、“定制化服务”等；
- 选填项：选填项以官网内容为准，若没有则无需填写，不必AI生成。
- 图片格式：若无特殊录入样式，图片要求全部居中，大小合适。图片最小要能看清内容不模糊，最大不能占据整个屏幕。一般长方形图（例如头图）以1200-800为宜，比较方正的配图以500-800为宜。
详细内容如下：
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 价格说明
需要在此处填写官网服务的详细定价介绍或截图。
注意：定价中，较为离谱的翻译，需要通过修改前端页面的方法再截图，或转为文字说明也可。例如，免费的翻译成自由的，起始价翻译为启动器等等……
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次试用”等。
3.3 案例故事
服务相关的文章、新闻、案例可填写在此，将会展示在API HUB中，没有则不用填写。示例如下：
4 关于我们
需在【API推广-店铺管理-关于我们】处编辑，如图
此处内容主要为服务商的相关信息，一般可见于页面底部或顶部。
要求必须填写公司简介、工作时间（默认可填00:00-24:00）、联系方式（至少一种联系方式）。联系方式一般可见于官网【联系我们】页面或【隐私政策】内容中。
为了减少服务商信息收集的时间，详细信息只需要包含以下四部分的内容。以官网为主，官网有不要遗漏，官网实在没有就不用填写。
1、 公司简介+详细公司介绍 — 文字为主
公司简介一定要填，如果简介外有详细的公司介绍就放在详细信息里再描述一下，都以文字为主，详细介绍可以辅以图片。
Truora是一家拉丁美洲初创公司，热衷于构建出色的技术，并为各地的公司提供数字解决方案。Truora通过简化和自动化用户交互来帮助企业发展。
2、 公司发展史/公司历程/公司历史 — 图
3、 公司荣誉/荣誉证书/公司资质证书 — 图
4、 合作伙伴/客户案例/客户清单 — 图
三、常见问题清单
常见问题1：服务描述不合格。例如服务描述为机翻、有空格、不通顺、不符合逻辑等情况，需要重新润色一下。（任务表格中的服务描述仅为参考）
常见问题2：价格类型选择不准确/价格翻译不准确。请参考官网真实情况和计价说明-收费类型中的标准要求。
常见问题3：头图及内容不规范。
包括头图与内容无关、头图含有按钮、不清晰、尺寸不合适等。头图尺寸建议800-1200，建议长方形。按钮可以通过前段代码删除再截图。
头图只有图片，缺少文字描述。可将文字内容提取出来，为避免重复，在前端代码中删除重复的文字描述再截图
原图：
修改后：
常见问题4：正文内容样式不统一。
常见问题5：官网内容有遗漏。官网上有相关的内容，却没有整理进来，而是遗漏掉或使用AI生成。请仔细检查采购链接和官网链接中的内容。
常见问题6：对官网核心功能、核心优势、应用场景的理解把握不够，录入混乱。需要对核心功能、核心优势、应用场景这三点的内容加深理解。
常见问题7：产品介绍、核心功能、核心优势等内容只贴图，没文字。可将贴图内容分成文字与插图，提取出文字，然后将插图部分作为每一点对应的配图或整体作为配图，补充到文字后面。
参考示例：
录入前：https://www.truora.com/en/truchecks
录入后：https://apihub.explinks.com/api/scd202405222718249d9249
常见问题8：图文内容重复。同上处理方式
常见问题9：使用场景缺少图片或图文不符：使用场景要求图文结合，官网没有可以百度搜索无水印且内容相关的图片。
常见问题10：整篇图文内容比例不合适。图片过少，可读性较低。或者文字过少，图文失衡。一般文字与图片内容比例7:3即可。
常见问题11：图片尺寸有误。图片过大或过小，没有居中。在录入服务时需要考虑到图片的尺寸大小，是否居中放置，全文图片大小最好相一致，一般以500-800为宜。
常见问题12：详细价格图片翻译有误。如“免费”翻译成“自由”，“起始价”翻译成“起动机”等。
常见问题13：使用指南强行添加不相符的内容。使用指南中避免粘贴接口对接文档，或强行AI生成内容，若官网无使用指南相关内容，可以不填写，但不要遗漏。
常见问题14：关于我们内容缺失。关于我们内容需在【店铺管理-关于我们】中维护，必须填写简介和至少一个联系方式，服务时间若官网没有可填默认00:00-24:00。详细信息若官网有补充的内容，则需补充一下。
常见问题15：图片失效或裂开。避免直接使用外部网站上的图片链接，外网图片可用性难以控制，会出现图片裂开的情况。
解决办法：上传图片时，使用截图粘贴，或上传图片，尽量确保上传图片的地址是我们的存储服务器
Keyword: 情感倾向分析