本文档是QuickNode Marketplace的入门指南,它描述了如何将服务集成到web3开发堆栈。主要包括成为Marketplace合作伙伴、设计和构建Add-on、提交内部审核、发布Beta版并收集反馈、正式发布五个步骤。此外,还介绍了可用的Add-on类型(JSON-RPC、REST、外部Add-on)和身份验证方法。
QuickNode Marketplace 使你能够将服务直接分发给成千上万的现有和未来的 QuickNode 开发者。这是一种将你的产品集成到 web3 开发栈的有效方法。
本指南提供了将你的想法从概念转化为已发布的插件的分步路径。
为什么要在 QuickNode Marketplace 上构建?
在 QuickNode Marketplace 上构建提供了一个强大的平台来启动、分发和货币化你的服务。以下是我们合作伙伴的主要优势:
发布你的插件的过程包括四个主要步骤。每个步骤都涉及你这边的开发以及 QuickNode 团队的审核,以确保我们用户的质量和安全。
成为 Marketplace 合作伙伴:获取你的官方开发者帐户。
设计和构建你的插件:选择你的插件类型并构建它。
提交以进行内部审查:让 QuickNode 团队对你的插件进行技术验证。
在 Beta 版中发布并收集反馈:向公众发布你的插件以进行早期测试。
正式发布以实现全面可用性:从 Beta 版过渡到全面的公开版本。
现在,让我们详细了解每个步骤。
在构建之前,你需要一个合作伙伴帐户。这使你可以访问 Marketplace 仪表板,你可以在其中创建和管理你的插件。
要开始使用,你需要在 QuickNode Marketplace 上发布插件,你需要注册一个开发者帐户。从你的QuickNode 仪表板中,选择左侧导航菜单中的切换到合作伙伴选项,然后填写 Marketplace 帐户申请。以下是表格的预览:
审批过程通常需要 1-2 个工作日。你的合作伙伴帐户获得批准后,你将收到电子邮件通知。
这是核心开发阶段,你可以在其中将你的服务与 Marketplace 集成。
为 QuickNode Marketplace 创建插件时,你可以根据你想要提供的服务从三种主要类型中进行选择:
示例:BTC Blockbook JSON-RPC 添加了一个
bb_getBalanceHistory
方法来获取比特币地址的历史余额数据。
GET
、POST
、PUT
、DELETE
) 与区块链数据或外部服务交互。示例:Aerodrome Swap API 提供诸如
GET v1/pools
和POST v1/swap/build
等端点,以提供跨多个区块链的交换报价和构建交易。
示例:Covalent 的 GoldRush Wallet API 让开发者可以获取 API 密钥,并通过他们自己的服务直接访问钱包数据。
QuickNode 支持多种身份验证选项,以帮助你控制对插件的访问。选择与你的服务设计方式相匹配的选项:
基于标头的身份验证:使用自定义 HTTP 标头(例如 x-api-key
)来验证请求。如果你的 API 已经支持基于标头的身份验证,这是最简单的选择,因为它不需要任何更改。
HTTP 基本身份验证:使用用于所有 Marketplace 流量的单个用户名和密码来保护你的端点。此选项设置起来很简单,只需要进行少量的代码更新。
配置 API:通过实施端点来创建、更新和删除用户,从而使你可以完全控制客户帐户。最适合管理用户特定数据或服务的插件,因为你可以直接处理生命周期。
注意:包括仪表板或支持 SSO 登录的插件需要使用配置 API。
身份验证方法
有关每种方法的更多详细信息,请参阅我们的身份验证方法指南。
在确定了你的插件类型和身份验证方法后,就可以开始构建了。我们提供了多种资源,使开发变得简单高效。
请按照我们全面的 如何构建 Marketplace 插件 指南了解分步说明。本指南涵盖:
插件开发课程
如需获得实践学习体验,请查看 Marketplace 插件开发课程。在本课程中,我们将从头开始构建一个功能齐全的 RPC 插件(区块时间戳查找),涵盖该过程的每个步骤。
开发完插件后,你需要在合作伙伴仪表板中对其进行配置并提交以进行技术审查。此步骤可确保你的服务在公开访问之前是稳定、安全且正确集成的。
合作伙伴仪表板中的提交表格是你在其中定义插件各个方面的表格。要完成它,你需要提供三个主要类别的信息:
列表和营销详细信息:这包括你的插件的名称、描述、图标和屏幕截图,这些信息将显示在 Marketplace 中。
技术配置:你将指定你的插件类型,提供服务 URL,定义 RPC 方法或 REST 端点(如果适用),并列出支持的链。
商业模式:在这里,你将概述插件的功能并构建你的定价计划(例如,免费、专业版、企业版)。
准备你的列表
有关创建你的列表详细信息、图标、屏幕截图和定价计划的最佳实践,请参阅我们的 营销和业务详细信息 指南。
在你在提交表格中输入了所有必需的详细信息后,你就可以将其发送给我们的团队了。
在点击提交按钮之前,请执行最终检查以确保你的所有服务 URL(包括你的 API 端点和运行状况检查)均可正常使用且可公开访问。提前验证此信息有助于防止审核过程中出现常见的延迟。
发布你的插件
有关如何发布你的插件的详细指南,从填写提交表到全面可用性发布,请参阅我们的如何发布你的插件 指南。
在你的插件成功通过内部审查后,它将在 Marketplace 上发布并带有 Beta 标签。这使你的服务可公开访问所有 QuickNode 用户,从而使你可以在全面发布之前从早期采用者那里收集真实世界的反馈。
现在是执行你的 Beta 测试策略的时候了。向你的社区宣布发布,并与用户互动以收集有关功能、用户体验和文档的宝贵反馈。此反馈将帮助你改进你的插件并使其更易于使用。
最后一步是从 Beta 版过渡到全面的公开版本。过渡到全面可用性 (GA) 会删除 Beta 标签,并将你的插件作为 Marketplace 中完全支持的解决方案呈现。
在你收集了足够的反馈并解决了在 Beta 期间发现的任何关键问题后,你可以从你的合作伙伴仪表板申请全面可用性。
你现在已经清楚地了解了在 QuickNode Marketplace 上发布需要做些什么。下一步是开始构建你的插件。
如果你尚未决定使用哪种身份验证方法,请查看 Marketplace 插件的身份验证方法 指南,以选择最适合你的服务的选项。
准备就绪后,请按照 如何构建 Marketplace 插件 指南了解详细的分步开发说明、代码示例和最佳实践,以帮助你创建你的第一个插件。
如果你对新主题有任何反馈或要求,请告诉我们。我们很乐意收到你的来信。
- 原文链接: quicknode.com/guides/mar...
- 登链社区 AI 助手,为大家转译优秀英文文章,如有翻译不通的地方,还请包涵~
如果觉得我的文章对您有用,请随意打赏。你的支持将鼓励我继续创作!