> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cleariflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API аватаров

> API аватаров Cleariflow — быстрый, лёгкий, современный RESTful JSON API для создания настраиваемых изображений аватаров с инициалами из имени пользователя для улучшения UX.

Использование простое: передайте `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
```

Запрос обработан успешно — ниже аватар для указанного имени:

<img alt="Avatar for Alexander Rodriguez" src="https://mintcdn.com/cleariflow/JFqWO7lxhDZeTQpu/assets/cf_avatar.png?fit=max&auto=format&n=JFqWO7lxhDZeTQpu&q=85&s=45fdc40cc251d6313c13a9c620b320b7" width="64" height="64" data-path="assets/cf_avatar.png" />

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

<ParamField query="api_key" type="String" required>
  Ваш эксклюзивный API-ключ. У каждого пользователя уникальные ключи для каждого сервиса Cleariflow, поэтому ключ Avatars не будет работать, например, с API геолокации IP.
</ParamField>

<ParamField query="name" type="String" required>
  Имя, для которого нужно сгенерировать аватар. Можно передать несколько имён (имя, отчество, фамилия) — сервис автоматически покажет две буквы. Количество букв можно изменить параметром char\_limit ниже.
</ParamField>

<ParamField query="image_size" type="Integer">
  Размер квадратного изображения аватара в пикселях. По умолчанию 64 пикселя, допустимый диапазон — от 6 до 512.
</ParamField>

<ParamField query="image_format" type="String">
  Предпочитаемый формат изображения. По умолчанию «png», также можно выбрать «svg».
</ParamField>

<ParamField query="font_size" type="Float">
  Размер шрифта в процентах от image\_size. По умолчанию 0.7, допустимые значения — от 0.1 до 1.0.
</ParamField>

<ParamField query="char_limit" type="Integer">
  Максимальное количество символов на аватаре. По умолчанию 2. Фактическое число может быть меньше лимита, но не больше. Приоритет: сначала разные слова, затем вторая буква разных слов.
</ParamField>

<ParamField query="background_color" type="String">
  Шестнадцатеричный цвет фона. По умолчанию #335eea. При указании hex-цвета не включайте символ «#». Например, \&background\_color=e4704a допустимо, а \&background\_color=#e4704a — нет.
</ParamField>

<ParamField query="font_color" type="String">
  Шестнадцатеричный цвет текста. По умолчанию белый (ffffff). При указании hex-цвета не включайте символ «#». Например, \&font\_color=e4704a допустимо, а \&font\_color=#e4704a — нет.
</ParamField>

<ParamField query="is_rounded" type="Boolean">
  Генерирует круглый аватар вместо квадратного. По умолчанию false.
</ParamField>

<ParamField query="is_uppercase" type="Boolean">
  Преобразует все инициалы в заглавные буквы. По умолчанию true.
</ParamField>

<ParamField query="is_italic" type="Boolean">
  Применяет курсив ко всем инициалам. По умолчанию false.
</ParamField>

<ParamField query="is_bold" type="Boolean">
  Применяет жирное начертание ко всем инициалам. По умолчанию false.
</ParamField>