如何发布你的插件

概述

本指南涵盖了在 QuickNode Marketplace 上发布已完成的插件的步骤。它将引导你完成准备列表详情、填写合作伙伴仪表板中的提交表单以及了解审核和发布过程的步骤。

你将做什么

• 为你的插件准备必要的营销、技术和业务信息
• 完成插件提交表单的每个部分
• 了解在内部审核、beta 发布和全面可用阶段会发生什么
• 了解 QuickNode 用于评估新插件的标准

前提条件

在你开始本指南之前，请确保你已准备好以下内容：

• 已批准的合作伙伴帐户：整个过程在合作伙伴仪表板中进行。如果你尚未获得批准，请从我们的 入门指南 开始。
• 完全开发的插件：你必须有一个完整的、经过本地测试的插件。如果你尚未完成技术实施，请首先按照我们的 如何构建 Marketplace 插件指南 进行操作。
• 完整的列表材料：你应该准备好插件的名称、描述、图标、屏幕截图和最终定价计划，如 准备你的 Marketplace 列表指南 中所述。

步骤 1：填写提交表单

准备好详细信息后，你现在可以完成提交过程。登录你的 QuickNode 仪表板，然后通过单击右上角的个人资料图标并选择“切换到合作伙伴”来导航到“合作伙伴”部分。

基本信息

本节涵盖了你的插件的核心详细信息。

• 插件名称和描述：为你的插件提供一个清晰、描述性的名称、一个简短的描述和一个详细的描述。
• 图标和屏幕截图：上传你准备的视觉资产。
• 支持电子邮件和 URL：提供寻求支持的用户的联系信息。
• 警报电子邮件：输入一个电子邮件地址，QuickNode 可以向该地址发送有关你的插件状态和健康状况的自动警报。
• 支持的链和网络：选择你的插件支持的所有链和网络（例如，以太坊主网、Polygon PoS）。

技术配置

在这里，你将定义你的插件如何与 QuickNode 平台集成。

• 身份验证方法：选择与你的实现相匹配的方法：

  • Provisioning APIs
  • HTTP Basic Auth
  • Custom HTTP Header
  • No Authentication

• JWT Secret (如果适用)：如果你的插件有自己的仪表板，并且 QuickNode 用户需要访问它，你必须提供一个安全的密钥来签署 JSON Web Tokens。你可以使用以下命令生成一个：openssl rand -hex 32。

• 使用客户的 QuickNode API 端点：如果你的插件需要调用用户的底层 QuickNode 端点，请选择“是”。 选择“是”可确保这些调用正确归因于用户的端点。

插件类型详细信息

接下来，你将为你选择的插件类型提供特定的配置详细信息。

• RPC
• REST
• External

对于每个自定义 JSON-RPC 方法，你必须定义其结构和行为：

• 方法名称：你的自定义方法的名称（例如，qn_fetchTokenBalance）。

• 参数结构：参数的结构方式。

  • 按位置（数组）：参数按顺序传递（例如，["param1", "param2"]）。
  • 按名称（对象）：参数作为命名对象传递（例如，{"param1": "value1", "param2": "value2"}）。
• 参数数量：指定该方法需要的参数数量。（仅当参数结构按位置排列时有效）
• 上游服务 URL：你的 RPC 服务的完整 URL（例如，https://www.yourservice.com/rpc）。
• 健康检查 URL：用于监视你的服务可用性的 URL（例如，https://www.yourservice.com/healthcheck）。
• 文档 URL：指向你的公共 API 文档的链接（例如，https://yourservice.com/docs/api）。
• 描述：对该方法的作用的清晰解释。

输入一个方法的所有详细信息后，单击“添加”。 重复此过程，直到列出并配置所有你的方法。

添加 RPC 方法后，你应该更新每个方法，以包括详细的参数信息，例如参数名称、数据类型和示例值。 请注意，输入示例值时，仅提供原始值。 例如，如果数据类型为 string，请勿在示例值周围加上引号 (")。

对于你的插件公开的每个 REST 路径，你需要提供以下信息：

• HTTP 方法：该路径的方法（例如，GET、POST）。
• REST API URL：特定路径的完整上游 URL（例如，https://api.yourservice.com/v1/prices）。 如果你的 URL 具有占位符，请使用花括号（例如，https://api.yourservice.com/v1/prices/{currency}）。
• 健康检查 URL：用于监视你的服务可用性的 URL。
• 文档 URL：指向你的公共 API 文档的链接。
• 描述：对该端点的作用的清晰解释。
• 示例 URL：一个完整的、可执行的 URL，带有真实的示例值，供用户测试（例如，https://api.yourservice.com/v1/prices/ETH）。
• 示例查询字符串：如果端点接受查询参数，请提供一个示例（例如，currency=EUR&exchange=coinbase）。

输入一个 REST 路径的所有详细信息后，单击“添加”。 重复此过程，直到列出并配置所有你的路径。

对于 External 插件，你必须为用户提供清晰的说明。 随意使用 Markdown 格式来增强可读性。

• 入门说明：编写一个清晰的、循序渐进的指南，该指南将在用户启用你的插件后立即向其显示。 这应该解释他们如何通过 SSO 访问其仪表板以及在哪里找到其 API 密钥或其他必要的设置信息。

功能

在本节中，列出你的插件的主要功能。 使用它来高亮显示你的服务对潜在用户来说有价值和独特之处。 此信息用于 Marketplace 列表页面，并帮助用户比较计划。

你在此处提及的每个功能都将直接与你稍后设置的计划相关联。

计划

最后，定义你将提供的订阅层级。 对于每个计划（例如，“入门版”、“专业版”），你将设置每月价格并将特定功能与该层级的用户相关联。 这使你可以创建灵活的定价，该定价可以根据用户需求进行扩展。

如果你的插件是 RPC 或 REST，则应定义以下其他字段：

• Request Per Second (RPS) Limit
• Monthly Request Limit

注意： 如果你已设置 QuickNode，QuickNode 将强制执行插件计划的 Request Per Seconds Limit (RPS Limit) 和 Monthly Requests Limit。 你无需在插件中实现此功能。

测试访问

在提交插件之前，最后一步是向 QuickNode 团队请求测试访问。 此步骤验证你的插件在启动前在 QuickNode 的基础架构中运行是否顺畅。

仔细查看表格，一旦一切看起来准确无误，请单击“提交请求”。 如果你发现任何问题，请在提交之前进行必要的更新。

更新身份验证详细信息（如果适用）

对于使用 Provisioning APIs 的插件，QuickNode 将在你提交插件请求后颁发专用凭据。 这些凭据取代你在开发期间使用的任何临时用户名和密码。 你必须更新服务器的环境变量以使用提供的凭据，这些凭据将在 QuickNode 仪表板的“安全性”选项卡中提供。

这些凭据是你的插件独有的，必须确保安全。 所有经过身份验证的配置、更新和取消配置请求都需要它们。

步骤 2：审核和测试过程

在你完成并提交表单后，你的插件将进入我们的审核和测试流程。 此过程包括我们团队的审核，然后是你验证插件在 QuickNode 环境中的行为的集成测试阶段。

QuickNode 的内部审核

第一阶段是 QuickNode 团队的技术审核。 我们将检查你的配置，测试你的端点，并确保你的服务稳定、安全并提供良好的用户体验。 如果发现任何问题或对你的实现有任何疑问，我们将直接与你联系。

集成测试

一旦你的插件通过了我们的内部审核，你将被授予在 QuickNode 基础架构中对其进行测试的权限。 这使你可以验证完整的用户生命周期，并确保你的集成在公开发布之前正常工作。 你可以模拟用户操作并测试诸如以下功能：

• Provisioning, updating, deprovisioning, and deactivating (PUDD) 事件
• 通过实时 QuickNode 端点直接插件调用
• 完整的 Single Sign-On (SSO) 集成流程

注意

此集成测试环境目前仅适用于使用 Provisioning APIs 身份验证方法的插件。

步骤 3：Beta 发布

在你在集成环境中彻底测试了你的插件，并对其稳定性和性能充满信心后，下一步是申请 Beta Access。 这将使你的插件在 Marketplace 上公开可用，并带有 Beta 标签，从而使你可以从早期采用者那里收集反馈。

在 beta 阶段，你应该争取至少有 10 个活跃用户测试你的插件，以确保你在全面发布之前收到足够且有意义的反馈。

步骤 4：全面可用

在成功完成 beta 阶段并解决了用户反馈后，你可以申请转移到全面可用状态。 这将删除 Beta 标签，并将你的插件列为完全支持的、可用于生产的解决方案。

结论

恭喜！ 你的插件现在已在 QuickNode Marketplace 上线，可供全球开发人员使用。 这标志着我们合作伙伴关系的开始，我们致力于你的成功。

继续与你的用户互动，收集反馈，并将你的插件推销给社区。 有关促销策略和最佳实践，你可以随时参考 准备你的 Marketplace 列表 指南。

我们 ❤️ 反馈！

如果你对新主题有任何反馈或要求，请 告诉我们。 我们很乐意收到你的来信。

• 原文链接： quicknode.com/guides/mar...
• 登链社区 AI 助手，为大家转译优秀英文文章，如有翻译不通的地方，还请包涵～