跳转到主要内容
GET
/
v1
头像 API
curl --request GET \
  --url https://avatars.cleariflow.com/v1
使用方法非常简单：只需提供您的 api_key 和 name，系统将生成与所提供姓名首字母对应的头像图片。

​
快速开始

​
REST

头像 API 与所有 Cleariflow 服务采用相同的架构模式，基于 REST 原则构建。它采用可预测的资源导向 URL，并使用 HTTP 状态码进行错误通信。

​
HTTPS

头像 API 要求所有数据传输使用 TLS 1.2 或更高版本的加密协议进行保护。

​
API 版本

每个 Cleariflow 服务均包含版本控制。头像 API 当前运行在第 1 版。

​
您的 API 密钥

API 密钥是您访问 Cleariflow 头像 API 的唯一身份验证凭证。请记住，每个 Cleariflow 服务都有独立的 API 密钥，因此访问头像和邮箱验证等不同服务需要不同的密钥。要验证您的请求，必须在基础 URL 中包含 API 密钥。

​
基础 URL

https://avatars.cleariflow.com/v1/

​
验证端点

Cleariflow 头像 API 只需您的唯一 API 密钥和用户姓名即可生成头像： 
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
此请求已成功处理，指定姓名的头像如下： Alexander Rodriguez 的头像

​
请求参数

​
api_key
String
必填
您的唯一 API 密钥。请记住，每个用户为每个 Cleariflow 服务拥有 独立的 API 密钥，因此您的头像 API 密钥无法用于 IP 地理定位 API，例如。
​
name
String
必填
您要生成头像的姓名。可输入多个姓名（包括名、中间名和姓）， 服务将自动在头像中显示两个字母。可使用下方的 char_limit 参数修改字母数量。
​
image_size
Integer
正方形头像图片的像素尺寸。默认为 64 像素，可用尺寸范围为 6 到 512 像素。
​
image_format
String
生成图片的首选格式。默认为 “png”，也可选择 “svg”。
​
font_size
Float
字体大小，以 image_size 的百分比表示。默认为 0.7，可接受值为 0.1 到 1.0。
​
char_limit
Integer
头像中显示的最大字符数。默认为 2。实际显示的字符数可能少于此限制，但不会更多。字符选择优先不同单词的首字母，然后是不同单词的第二个字母。
​
background_color
String
背景的十六进制颜色代码。默认为 #335eea。指定十六进制颜色时，省略 ”#” 符号。例如，&background_color=e4704a 有效，而 &background_color=#e4704a 无效。
​
font_color
String
文字的十六进制颜色代码。默认为白色 (ffffff)。指定十六进制颜色时，省略 ”#” 符号。例如，&font_color=e4704a 有效，而 &font_color=#e4704a 无效。
​
is_rounded
Boolean
生成圆形头像图片而非正方形。默认为 false。
​
is_uppercase
Boolean
将头像中所有首字母转换为大写。默认为 true。
​
is_italic
Boolean
对头像中所有首字母应用斜体样式。默认为 false。
​
is_bold
Boolean
对头像中所有首字母应用粗体样式。默认为 false。