注册后,每个开发者都会被分配一个个人 API 访问密钥,这是一个唯一的字母和数字组合,用于访问我们的 API 端点。要使用 ClearCheck 颜色转换器和 WCAG 对比度检查器 API 进行身份验证,只需在 Authorization 标头中包含您的 bearer token。
| 标头 | 描述 |
|---|---|
授权
|
必需
应为 Bearer access_key. 订阅后,请查看上方的"您的 API 访问密钥"。
|
该转换器接受 HEX RGB HSL CMYK 和常见 CSS 颜色名称并返回对应的 HEX RGB HSL CMYK CSS 字符串 alpha 和相对亮度表示例如“#1e90ff”会产生 RGB 值 30 144 和 255
响应可以包含原始输入、`hex`、`hex_with_alpha`、`rgb`、`alpha`、`hsl`、`cmyk`、`css` 和 `relative_luminance` RGB 由 `r`、`g` 和 `b` 表示;HSL 由 `h`、`s` 和 `l` 表示;CMYK 由 `c`、`m`、`y` 和 `k` 表示
`alpha` 表示不透明度,其中 1 表示完全不透明。`hex_with_alpha` 在适用时包含带有 alpha 通道的 HEX 值,如果未返回单独的 alpha 表示,则可能为 `null`。显示或处理可空字段前,务必先进行检查。
`relative_luminance` 是用于 WCAG 对比度计算的归一化亮度值。它有助于比较前景色和背景色,并判断文本是否符合 AA 或 AAA 对比度要求。示例颜色 `#1e90ff` 的亮度约为 `0.2744`】【。
比较两种颜色并提供它们的对比度以及 WCAG 2.x 无障碍标准评定结果,包括 AA 和 AAA 结果。将颜色分别用作前景色和背景色输入,以评估文本或界面元素在选定背景下的可读性
给定背景颜色后,它会根据黑色或白色哪种文字更易于阅读来进行选择。这有助于为徽章、按钮、标签、卡片和其他具有动态背景的组件自动选择易于访问的文字
是的。该 API 为颜色转换、WCAG 对比度比较和黑白文字选择提供 GET 和 POST 版本。请使用客户端或集成所支持的方法,并通过端点预期的查询参数或请求正文参数发送所需的颜色值
错误以 JSON 格式返回,结构为 `{"error":{"code","message"}}`。`code` 标识错误类别,而 `message` 说明问题。客户端应在读取转换、对比或文本选择结果之前检查是否存在 `error` 对象.