Перейти до основного вмісту
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 має власний унікальний API-ключ, тому для різних сервісів, як-от Avatars і Email Validation, потрібні окремі ключі. Для автентифікації запитів включіть API-ключ у базовий 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-ключ. Пам’ятайте: у кожного користувача є унікальні API-ключі для кожного сервісу Cleariflow, тому ключ Avatars API не працюватиме для 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.