Перейти к основному содержанию
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-ключ — эксклюзивные учётные данные для доступа к API аватаров Cleariflow. У каждого сервиса Cleariflow свой ключ, поэтому для Avatars и Email Validation, например, нужны разные ключи. Для аутентификации включите ключ в базовый URL.

​
Базовый URL

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

​
Эндпоинт генерации

API аватаров Cleariflow требует только ваш уникальный API-ключ и имя пользователя для генерации аватара: 
https://avatars.cleariflow.com/v1/
? api_key = YOUR_UNIQUE_API_KEY
& name = Alexander Rodriguez
Запрос обработан успешно — ниже аватар для указанного имени: Avatar for Alexander Rodriguez

​
Параметры запроса

​
api_key
String
обязательно
Ваш эксклюзивный API-ключ. У каждого пользователя уникальные ключи для каждого сервиса Cleariflow, поэтому ключ Avatars не будет работать, например, с API геолокации IP.
​
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. При указании hex-цвета не включайте символ «#». Например, &background_color=e4704a допустимо, а &background_color=#e4704a — нет.
​
font_color
String
Шестнадцатеричный цвет текста. По умолчанию белый (ffffff). При указании hex-цвета не включайте символ «#». Например, &font_color=e4704a допустимо, а &font_color=#e4704a — нет.
​
is_rounded
Boolean
Генерирует круглый аватар вместо квадратного. По умолчанию false.
​
is_uppercase
Boolean
Преобразует все инициалы в заглавные буквы. По умолчанию true.
​
is_italic
Boolean
Применяет курсив ко всем инициалам. По умолчанию false.
​
is_bold
Boolean
Применяет жирное начертание ко всем инициалам. По умолчанию false.