Hermai AI icon

Hermai AI

Hermai AI 的 Hermai Brand API 可将客户工作邮箱或公司域名转为品牌数据,用于 B2B SaaS 的白标 onboarding、资料预填和客户界面主题,一次 API 调用返回企业信息、logo 和安全配色。

Hermai AI

面向 B2B SaaS 的白标品牌化

Hermai Brand API 是一款面向 B2B SaaS 产品的白标 API。它接收客户的工作邮箱或公司域名,并返回公司名称、描述、logo 以及可应用到你产品中的应用主题等品牌详情。

该页面将此 API 定位为一种让首次 onboarding 和账户设置无需人工上传品牌或单独设置流程、也能呈现客户专属体验的方式。它作为 Hermai 基于 credit 的 API 平台的一部分出售,Brand API 与服务中的其他功能共享每月 credits。

核心能力

通过邮箱或域名查找品牌

发送企业邮箱或公司域名后,返回企业身份记录,无需让客户上传品牌素材或配置品牌设置页面。

一次调用获取品牌资料

在单次 API 响应中返回客户名称、描述、logo 和可直接应用的应用主题,让 onboarding 保持在一步内完成。

应用主题输出

提供 action、tint、focus 和 on_action 等安全颜色值,页面注明这些颜色在交付前会进行对比度检查。

带证据的回退行为

在字段中包含来源证据,并在品牌无法清晰解析时保留一个备用主题。

可编辑的品牌上下文

支持可编辑资料字段和其他需要展示客户上下文的界面中的预填,同时不改变底层产品含义。

本地预览流程

在将 API 接入应用之前,通过 Hermai skills for Claude Code 和 Codex 提供本地预览流程。

团队使用 Brand API 的常见方式

  • 白标 onboarding

    在注册时添加客户品牌,让首次会话在无需人工设置或上传品牌素材的情况下也能呈现账户专属感。

  • 账户资料预填

    在资料或设置字段中预填公司描述和主题数据,同时保留字段供客户自行编辑。

  • 面向客户的门户

    将客户颜色和身份应用到仪表盘、门户和管理界面等需要给人以品牌化第一印象的地方。

  • 实现预览

    在连接实时 API 调用之前,先从你自己的应用根路径预览品牌化变体,这在决定品牌应出现在哪里时很有用。

  • 丰富化工作流

    当客户上下文需要驱动展示和路由时,可将同一个 Brand API 响应作为更广泛的丰富化或目录工作流的一部分。

Pros and Cons

Pros

  • 将企业识别、描述、logo 和主题输出整合到一次请求中。
  • 通过使用客户的邮箱或域名作为输入,减少了手动品牌设置。
  • 包含安全颜色值和备用主题,便于更干净地应用客户品牌。
  • 在返回字段上显示来源证据,有助于说明数据来自哪里。
  • 可以在集成前先进行本地预览,这有助于团队更早测试匹配度。

Cons

  • 公开页面只展示了部分功能和集成信息,因此基本请求和响应示例之外的工作流细节较为有限。
  • Brand API 共享 Hermai 的通用 credit 池,而不是单独的方案,这可能会让只关注品牌化的团队在使用规划上不够直观。

FAQ

Brand API 如何工作?

Hermai Brand API 通过发送工作邮箱或公司域名来使用。它会返回企业信息、描述以及你的应用可应用到面向客户界面的主题。

API 会返回什么?

页面展示了一个位于 /v1/brand/retrieve 的 POST 端点。响应摘录包含品牌名称、描述以及 application_theme 的颜色值。

Brand API 的使用如何计费?

品牌检索按每个完成的品牌资料收取 1 个 credit,使用与其他 Hermai 端点相同的 credit 池。待处理检查、失败结果以及 logo 交付是免费的。

我可以在使用 API 前先预览吗?

可以。网站说明在正式接入生产环境之前,可以先用 Hermai 的 Claude Code 或 Codex skill 预览 Brand API。

Quick Facts

类别
开发者工具
主要用途
用于 B2B SaaS onboarding 和账户界面的白标品牌化
输入
企业邮箱或公司域名
输出
品牌名称、描述、logo 和应用主题
计费模式
基于 credit 的 API 使用,含免费层
品牌端点
POST /v1/brand/retrieve