# Hermai Brand API Hermai Brand API 帮助 B2B SaaS 产品在注册时应用客户品牌身份；通过工作邮箱或公司域名，一次 API 请求即可返回公司名称、描述、Logo、来源证据及可应用于产品界面的主题。 - Findings24: - 网站: - 价格: Freemium - 分类: 开发者工具 ## 什么是 Hermai Brand API？ Hermai Brand API 是面向 B2B SaaS 产品的白标化与引导 API。产品可以使用工作邮箱或公司域名，获取客户的公司身份信息及应用主题，并将其应用到自己的界面中。 响应可以包含公司名称、描述、Logo、来源证据和主题颜色。文档示例返回带有来源 URL 和检测信号的品牌字段，以及用于操作、操作文字、色调和焦点状态的颜色。应用可自行决定将品牌应用到哪些受支持的界面区域。 该 API 面向注册和账户配置流程。它可以识别客户，无需客户上传 Logo 或手动配置品牌；返回的描述还可用于预填可编辑的资料字段。Hermai 的文档流程读取邮箱域名，而不会保留邮箱名称。 品牌应用受应用规则约束：客户身份可以影响选定的界面区域，而状态含义、语义颜色、正文文本、代码、API 密钥、布局、字体和行为保持不变。返回的颜色会经过对比度检查；如果客户主题不可用，回退机制可以保留产品现有主题。 ## Hermai Brand API 能做什么？ ### 从邮箱或域名获取品牌信息 向 Brand API 发送工作邮箱或公司域名，在注册或账户设置期间解析客户的公司身份信息。 ### 结构化公司资料数据 文档所述响应可以提供公司名称和描述，并为返回字段提供来源证据，包括来源 URL 和检测信号。 ### 应用主题输出 响应包含应用主题，其中包括操作、操作文字、色调和焦点等颜色值，SaaS 产品可将其映射到自己的主题系统中。 ### 品牌安全的应用规则 网站明确了客户品牌的适用位置，包括 Logo、公司名称、选定的导航、主要操作、焦点状态和细微的上下文界面区域，同时保留产品的语义含义。 ### 对比度检查与回退 颜色在交付前会经过对比度检查；如果客户主题不可用，应用可以使用回退机制保留自身主题。 ### 本地预览工作流 面向 Claude Code 和 Codex 的 \`brand-preview\` skill 可让团队在连接实时 API 之前，预览自己应用的五个品牌化版本。 ## 使用场景 ### 注册个性化 新客户注册时调用 API，然后使用返回的身份信息和主题，让首次会话体现该客户的品牌，而不是显示通用的试用体验。 ### 预填资料表单 使用返回的公司描述预填可编辑的客户资料字段，减少手动设置，同时让客户掌控最终文本。 ### 白标客户工作区 将客户 Logo、公司名称、选定的颜色和获准的界面区域应用到工作区、门户、仪表板或其他账户级视图中。 ### 实施前预览 从应用根目录运行本地预览 skill，查看多个真实品牌结果在仪表板中的呈现方式，然后再启用生产环境获取。 ## 常见问题 ### Brand API 接受什么输入？ 文档所述请求使用工作邮箱，网站也介绍了发送公司域名的方式。在邮箱流程中，Hermai 会读取域名部分；文档说明不会存储邮箱名称。 ### 完成品牌信息获取后可以返回什么？ 文档所述响应包括公司名称、公司描述、来源证据和包含颜色值的应用主题。产品页面还将 Logo 交付描述为该流程的一部分。 ### 客户品牌应应用到哪些位置？ 网站建议将客户品牌用于身份信息和选定的界面区域，例如 Logo、公司名称、主要操作、选定的导航、焦点状态以及一个非语义数据系列。错误、警告、破坏性操作、语义数据颜色、正文文本、代码、API 密钥、布局、字体和行为应保留产品原有含义。 ### Brand API 如何计费？ 定价页面说明，每个完成的品牌资料会从 Hermai 共享额度池中消耗 1 个 credit。待处理检查、不成功的结果和 Logo 交付不计费。公开方案包括 Free、Starter 和 Pro 的额度；自定义或私有来源以及企业需求通过销售团队处理。 ### 团队可以在使用实时 API 前测试结果吗？ 可以。Hermai 为 Claude Code 和 Codex 提供 \`brand-preview\` skill。文档所述工作流会从应用根目录运行该 skill，在连接实时 API 前预览品牌化版本。 ## 快速信息 - **产品类型**: 面向 B2B SaaS 的品牌化与引导 API - **主要输入**: 工作邮箱或公司域名 - **文档所述端点**: POST /v1/brand/retrieve - **核心输出**: 公司身份信息、描述、应用主题和来源证据 - **预览工具**: 通过 brand-preview skill 使用 Claude Code 和 Codex - **计费单位**: 每个完成的品牌资料消耗 1 个 credit