你有需求? 点击这里 尝试让 AI 为你生成Baklib调研方案!

Baklib Logo

企业发布公共API指南

  浏览:2 巴克励步

公共API可助企业集成软件、自动化任务、扩展服务,需考虑理解开发者需求、构建生态系统等六要素,推出步骤含完善文档、多渠道推广等,能促进合作与创新。

企业发布公共API指南
Baklib Dagle Tanmer CMS DXP DAM

在这个数字世界中,大多数软件应用程序都是通过SaaS模式交付的,即通过网页浏览器而非桌面客户端访问应用程序。客户通过前端与SaaS应用程序互动,并开展增值活动。应用程序编程接口(API)能帮助企业充分挖掘其软件套件的潜力。公共API帮助企业将其软件与客户可能用于其他目的的软件工具集成。这些基于API的集成能与客户建立信任,让他们相信你的软件应用程序可以帮助他们与其他应用程序进行数据交换。

公共API还能帮助客户自动化应用程序中的许多日常任务。一旦购买了软件应用程序,客户会围绕它们构建大量业务流程以开展增值活动。这些日常任务可以通过API轻松实现自动化。有第三方工作流自动化工具,如 ZapierMake、Workato 等,可用于自动化日常重复性活动。

公司的公共API也有助于扩展软件服务。公司的业务合作伙伴会有兴趣利用贵公司的API来扩展产品功能。公共API不提供花哨的功能,而是提供一种基础的"原味"版本,为业务合作伙伴构建新事物提供了大量机会。这也意味着整个生态系统可以围绕公共API来构建。生态系统会不断追求公共API的新功能,从而为持续的产品创新奠定基础。

推出公共API时需要考虑的六个关键因素

构建公共API对一家公司来说是一项战略性投资。公司应持续投资以提高其API的受欢迎程度,提供详细的文档,并随时间推移增强其可用性。以下是需要考虑的关键事项。

理解开发者的需求

理解开发者的需求是启动公共API开发的基础工作。API应能灵活适应开发者的需求,并提供丰富的数据交换功能。API应对开发者友好,并且必须非常易于使用。对于开发者来说,其他基本事项包括:

公共API应辅以开发文档,帮助开发者理解API的结构,并探索其关于输入和响应的文档。

  • “试用”功能

除了开发文档,公司还应提供一些“试用”功能,让开发者可以通过更改各种参数来尝试API,并能够查看响应。这有助于开发者熟悉API并理解其功能。

  • 代码示例

提供流行编程语言的代码示例,有助于开发者复制代码示例并快速将其集成到自己的软件应用程序中。这有助于最大限度地减少“实现价值的时间”这一商业指标。

围绕产品构建生态系统

围绕您的软件套件构建生态系统,对于最大化价值交付至关重要,更重要的是,这有助于您的软件应用在日益激烈的竞争威胁中生存。生态系统能帮助您的公司吸引广泛的商业合作伙伴网络,他们愿意利用您公司的公共 API 构建应用程序。这促使生态系统增长,并增强了客户根据其他业务需求扩展您软件应用的能力。构建生态系统通常涉及建立一个市场或提供连接器。像 WordPress、Shopify、Freshworks 等公司,都通过公开其公司的 API,成功围绕其产品构建了良好的生态系统。

安全性

在构建公共 API 时,API 的安全性至关重要。API 应通过安全的 HTTP 协议访问,并为 API 身份验证提供企业级的安全保障。此外,公司应有一种安全的方式帮助开发者获取 API 身份验证令牌。公司的公共 API 应遵守行业安全标准,并采用最佳实践来赢得开发者的信任。在 API 安全上的投入越多,随着其减轻新兴网络安全威胁,开发者的信任度也会随之增长。

API 使用

公共 API 应根据订阅计划设置速率限制,以确保开发者在指定限制内与 API 交互。公司还应制定良好的公平使用政策,以防止某些开发者向 API 服务器发送过多请求而损害所有人的利益!应为开发者提供技术支持,以帮助解决任何与 API 相关的问题。这体现了一个公司为使其公共 API 取得成功所投入的程度。

开发者门户

如果公司希望扩大其API服务范围,可以建立一个开发者门户。开发者门户提供了一个全面的视角,帮助开发者访问开发文档、试用API、与其他开发者互动、了解业务用例、推广客户成功案例、获取技术帮助等等。开发者门户也可以作为新API发布的测试平台。可以设置模拟服务器来模拟实时环境,让开发者可以在其中试用新的API并探索新功能。

持续创新

没有创新,增长就会停滞。公司应投资升级现有API并提供新的API,作为其产品创新的一部分。这意味着定期发布新的API版本,并随着时间的推移逐步淘汰旧版本。这确保了您的软件应用程序与客户行为和技术趋势保持一致。许多公司已开始提供GraphQL作为其API服务的一部分,这有助于开发者在一次API调用中获得更多数据,而不是像旧模式那样进行多次API调用。在提供API时采用新技术可以缩短开发时间,从而使业务合作伙伴能够更灵活地应对变化。

延伸阅读:2023年6大最佳开发文档工具

  1. 一旦关键考虑因素得到解决,以下是推出公共API的简单步骤。
  2. 确保开发文档站点可用,并包含“试一试”功能和代码示例。
  3. 通过产品发布说明宣布新的API,并通过软件应用程序通知现有客户。
  4. 通过业务合作伙伴和其他社交媒体渠道推广新的API。
  5. 在知名的开发者大会上发布您的API,让开发者对新用例感到兴奋。
  6. 在您公司的网站上发布客户成功案例,以展示新的API如何创造了成功的业务成果。

对于一家公司来说,为其软件应用套件发布公共API是一个非常重要的里程碑。这促进了与业务合作伙伴的产品集成。解决方案集成商也可以利用公共API,根据客户需求构建技术栈。公司的公共API也有助于繁荣丰富的生态系统。开发者社区在生态系统构建者的支持下蓬勃发展,以构建新事物和提供新服务。为了维持开发者对公司API的兴趣,对API进行持续创新至关重要。因此,开放API使公司在其细分市场中成为重要的参与者。



BaklibCMSDXP 的领导者,帮助世界各地的组织创建现代化的网站和门户。Baklib 在多站点和多语言环境中蓬勃发展。内容管理应该更简单,多场景体验站点应该有助于构建强大的个性化和信息检索。Baklib 拥有 400 多个低代码集成模块,高度定制化的前端设计,非常适合您的堆栈。
Baklib Birds
to top icon