REST API · v1

Документація MakeFav API

Генеруйте повні пакети favicon зі свого коду, скриптів збірки та CI-пайплайнів. Один запит перетворює будь-яке зображення на favicon.ico, іконки Apple touch, іконки Android і PWA, веб-маніфест та готовий до вставки HTML.

На цій сторінці

Швидкий старт

MakeFav API – це простий REST API на основі HTTPS і JSON. Усі ендпоінти розташовані за єдиною базовою URL-адресою:

https://makefav.com/api/v1
  1. Створіть безкоштовний обліковий запис
    Зареєструйтеся, підтвердьте адресу електронної пошти та залишайте активною підписку на розсилку MakeFav – це єдина умова безкоштовного тарифу.
  2. Створіть API-ключ
    Відкрийте сторінку API-ключів в обліковому записі та створіть особистий ключ. Він починається з mf_ і показується лише один раз, тому зберігайте його надійно. Керування API-ключами
  3. Надішліть перший запит
    Завантажте зображення на ендпоінт generate і збережіть отриманий ZIP-файл:
curl --fail-with-body -sS https://makefav.com/api/v1/generate \
  -H "Authorization: Bearer $MAKEFAV_API_KEY" \
  -F "[email protected]" \
  -F "app_name=My App" \
  -F "theme_color=#2f9e68" \
  -F "radius=20" \
  -o favicons.zip

Unzip favicons.zip, upload the files to your website and paste the HTML code from the end of readme-makefav.txt into the <head> of every page.

Автентифікація

Кожен запит до захищеного ендпоінта має містити особистий API-ключ. Ви можете створювати, називати й відкликати ключі будь-коли на сторінці свого облікового запису: API-ключі

Send the key as a bearer token in the Authorization header, or – if your HTTP client makes that awkward – in the X-API-Key header. Both are equivalent.

Authorization: Bearer mf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# or, alternatively
X-API-Key: mf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Ключі належать користувачеві з підтвердженою адресою електронної пошти та активною підпискою на розсилку (умова безкоштовного тарифу). Якщо пошту не підтверджено, розсилку вимкнено або обліковий запис заблоковано, кожен запит повертає 403 Forbidden.
Ставтеся до API-ключів як до паролів: зберігайте їх на сервері або в секретах CI, ніколи не додавайте в код для браузера, мобільні застосунки чи публічні репозиторії. У разі витоку негайно відкличте ключ.

Missing or invalid keys return 401 Unauthorized. The GET /sizes and GET /openapi.json endpoints do not require a key.

Ліміти запитів

За замовчуванням кожен API-ключ може робити 100 запитів на годину. Кожна автентифікована відповідь показує ваш поточний стан:

ЗаголовокОпис
X-RateLimit-LimitМаксимальна кількість запитів, дозволена в поточному вікні.
X-RateLimit-RemainingЗалишок запитів у поточному вікні.
X-RateLimit-ResetUnix-мітка часу (секунди, UTC) скидання вікна.
HTTP/1.1 200 OK
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1767225600

When the limit is exceeded the API responds with HTTP 429 and the error code rate_limited. Wait until the time in X-RateLimit-Reset before retrying – do not retry in a tight loop.

HTTP/1.1 429 Too Many Requests
Content-Type: application/json
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1767225600

{"error": {"code": "rate_limited", "message": "Rate limit exceeded. Try again after the reset time."}}

You can check your current quota at any time with GET /me.

Ендпоінти

ЕндпоінтАвтентифікаціяОпис
POST /generateAPI-ключСтворити повний пакет favicon.
GET /meAPI-ключВаш обліковий запис і поточний стан ліміту запитів.
GET /sizesНемаєСписок усіх файлів іконок і розмірів, які створює генератор.
GET /openapi.jsonНемаєМашинозчитувана специфікація OpenAPI 3.1.

Згенерувати пакет favicon

POST/generate

Створює повний пакет favicon з одного вихідного зображення. Надішліть зображення одним із трьох способів:

Тип вмістуПоле зображенняОпис
multipart/form-dataimageЗавантаження файлу. Рекомендовано – найефективніший варіант.
application/jsonimage_base64Base64-encoded image, either raw base64 or a data URL such as data:image/png;base64,iVBOR….
application/jsonimage_urlПублічна http- або https-адреса зображення. Сервер завантажує його (макс. 10 МБ).

Підтримувані вхідні формати: PNG, JPG, WebP, AVIF, GIF, BMP, SVG та ICO. Максимальний розмір файлу: 10 МБ.

Параметри

Усі параметри необов’язкові. Надсилайте їх як поля форми (multipart) або як властивості JSON. Недійсні значення замінюються значенням за замовчуванням.

Ім’яТип / діапазонЗа замовчуваннямОпис
app_nameрядок, макс. 60 символівMy WebsiteНазва вашого сайту чи застосунку, використовується в manifest.json і на прикладі сторінки.
short_nameрядок, макс. 24 символиперші 12 символів app_nameКоротка назва під іконкою на домашніх екранах Android.
theme_color#rrggbb#ffffffКолір інтерфейсу браузера (мета-тег theme-color і маніфест).
tile_color#rrggbbтакий самий, як theme_colorКолір тла плиток Windows на екрані «Пуск».
backgroundtransparent | #rrggbbtransparentТло іконок для браузера, Android і Windows.
apple_background#rrggbb#ffffffТло іконок Apple touch і maskable-іконки (iOS не підтримує прозорість). Ігнорується, якщо background має колір – тоді використовується цей колір.
paddingціле число, 0–40 (%)0Порожній простір навколо зображення у відсотках від розміру іконки.
radiusціле число, 0–50 (%)0Заокруглені кути. Значення 50 дає коло. Не застосовується до іконок Apple, які iOS заокруглює самостійно.
zoomціле число, 50–400 (%)100Масштаб зображення всередині іконки. Значення понад 100 обрізають зображення.
offset_x, offset_yчисло, від -1 до 10Зміщує зображення по горизонталі / вертикалі як частку розміру іконки.
pathрядок/Папка на вашому сервері, де зберігатимуться іконки. Використовується в HTML-фрагменті, маніфесті та browserconfig.
displaystandalone | fullscreen | minimal-ui | browserstandaloneРежим відображення PWA, записаний у маніфест.
pixelatedauto | 1 | 0autoЧітке масштабування методом найближчого сусіда для піксель-арту. Значення auto вмикає його для джерел розміром 64 px або менше.
maskable1 | 01Також створити maskable-icon-512x512.png із відступом безпечної зони для адаптивних іконок Android.
ico_sizesсписок через кому: 16, 24, 32, 48, 64, 128, 25616,32,48Розміри, вбудовані у favicon.ico.
groupsсписок через кому: favicon, apple, android, msfavicon,apple,android,msНабори іконок для генерації: favicon для браузерів, іконки Apple touch, іконки Android / PWA та плитки Windows.
formatzip | jsonzipФормат відповіді – див. нижче.

Відповідь

format=zip
Binary ZIP archive with Content-Type: application/zip and Content-Disposition: attachment. Default.
format=json
JSON object with the package id (32 hex characters), the html snippet for your <head> and a files array; each file has name, mime, size (bytes) and base64 contents.

Приклад запиту – multipart, відповідь у форматі ZIP

curl --fail-with-body -sS https://makefav.com/api/v1/generate \
  -H "Authorization: Bearer $MAKEFAV_API_KEY" \
  -F "[email protected]" \
  -F "app_name=My App" \
  -F "theme_color=#2f9e68" \
  -F "radius=20" \
  -o favicons.zip
HTTP/1.1 200 OK
Content-Type: application/zip
Content-Disposition: attachment
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1767225600

<binary ZIP data>

Приклад запиту – JSON з URL зображення, відповідь у форматі JSON

curl --fail-with-body -sS https://makefav.com/api/v1/generate \
  -H "Authorization: Bearer $MAKEFAV_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image_url": "https://example.com/logo.png",
    "app_name": "My App",
    "theme_color": "#2f9e68",
    "radius": 20,
    "groups": "favicon,apple,android",
    "format": "json"
  }'
{
  "id": "9f86d081884c7d659a2feaa0c55ad015",
  "html": "<link rel=\"apple-touch-icon\" sizes=\"57x57\" href=\"/apple-icon-57x57.png\">\n…\n<meta name=\"theme-color\" content=\"#2f9e68\">",
  "files": [
    {"name": "favicon.ico", "mime": "image/x-icon", "size": 15086, "base64": "AAABAAMAEBAAAAEAIABoBAAANgAAACAg…"},
    {"name": "favicon-16x16.png", "mime": "image/png", "size": 612, "base64": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQ…"},
    {"name": "manifest.json", "mime": "application/json", "size": 1094, "base64": "ewogICAgIm5hbWUiOiAiTXkgQXBwIiwK…"}
  ]
}

Отримати дані акаунта

GET/me

Повертає користувача, якому належить API-ключ, і поточний стан ліміту запитів. Корисно для перевірки ключа. Потребує автентифікації; без параметрів.

Приклад запиту

curl -sS https://makefav.com/api/v1/me \
  -H "Authorization: Bearer $MAKEFAV_API_KEY"

Приклад відповіді

{
  "id": 1,
  "email": "[email protected]",
  "name": "Jane Doe",
  "rate_limit": {"limit": 100, "remaining": 97, "reset": 1767225600}
}

Список розмірів іконок

GET/sizes

Returns every icon file the generator can produce, with its pixel size and group. No authentication and no parameters. The group value matches the groups parameter of POST /generate.

Приклад запиту

curl -sS https://makefav.com/api/v1/sizes

Приклад відповіді

{
  "files": [
    {"name": "favicon-16x16.png", "size": 16, "group": "favicon"},
    {"name": "favicon-32x32.png", "size": 32, "group": "favicon"},
    {"name": "apple-touch-icon.png", "size": 180, "group": "apple"},
    {"name": "android-icon-192x192.png", "size": 192, "group": "android"},
    {"name": "ms-icon-144x144.png", "size": 144, "group": "ms"}
  ]
}

Специфікація OpenAPI

GET/openapi.json

Повертає опис цього API у форматі OpenAPI 3.1. Автентифікація не потрібна. Імпортуйте його в Postman, Insomnia або Swagger UI чи використайте для генерації типізованого клієнта для вашої мови програмування.

curl -sS https://makefav.com/api/v1/openapi.json -o makefav-openapi.json

Помилки

Successful requests return HTTP 200. Every error returns a JSON body with a stable, machine-readable code and a human-readable message. Always branch on the code, not on the message text.

HTTP/1.1 422 Unprocessable Content
Content-Type: application/json

{
  "error": {
    "code": "invalid_image",
    "message": "The uploaded file could not be decoded as an image."
  }
}
HTTP-статусКод помилкиЗначення
400bad_requestЗапит сформовано некоректно, наприклад, зображення не надіслано або тіло JSON недійсне.
401unauthorizedAPI-ключ відсутній або недійсний.
403forbiddenЕлектронну адресу власника ключа не підтверджено, підписку на розсилку вимкнено або акаунт заблоковано.
413file_too_largeЗображення більше за 10 МБ.
415unsupported_typeТип файлу або тип вмісту запиту не підтримується.
422invalid_imageНе вдалося декодувати файл як зображення або завантажити зображення за URL.
429rate_limitedЗабагато запитів. Зачекайте до X-RateLimit-Reset.
500server_errorЩось пішло не так на нашому боці. Спробуйте пізніше; якщо проблема не зникне, зверніться до підтримки.

Вихідні файли

With all groups enabled, a package contains the files below. Files from disabled groups are left out.

ФайлРозмірГрупа
favicon.ico16, 32, 48 (налаштовується)завжди
favicon-16x16.png16 × 16favicon
favicon-32x32.png32 × 32favicon
favicon-96x96.png96 × 96favicon
apple-icon-57x57.png57 × 57apple
apple-icon-60x60.png60 × 60apple
apple-icon-72x72.png72 × 72apple
apple-icon-76x76.png76 × 76apple
apple-icon-114x114.png114 × 114apple
apple-icon-120x120.png120 × 120apple
apple-icon-144x144.png144 × 144apple
apple-icon-152x152.png152 × 152apple
apple-icon-180x180.png180 × 180apple
apple-icon.png192 × 192apple
apple-icon-precomposed.png192 × 192apple
apple-touch-icon.png180 × 180apple
android-icon-36x36.png36 × 36android
android-icon-48x48.png48 × 48android
android-icon-72x72.png72 × 72android
android-icon-96x96.png96 × 96android
android-icon-144x144.png144 × 144android
android-icon-192x192.png192 × 192android
android-icon-512x512.png512 × 512android
web-app-manifest-192x192.png192 × 192android
web-app-manifest-512x512.png512 × 512android
maskable-icon-512x512.png512 × 512android
ms-icon-70x70.png70 × 70ms
ms-icon-144x144.png144 × 144ms
ms-icon-150x150.png150 × 150ms
ms-icon-310x310.png310 × 310ms

Додаткові файли

ФайлВключеноОпис
favicon.svgЛише для SVG без обрізання, масштабування, відступів, заокруглення кутів або фонуОчищена копія вашого SVG для браузерів, які підтримують векторні favicon.
manifest.json, site.webmanifestandroidМаніфест веб-застосунку для Android і PWA, що встановлюються (дві однакові копії).
browserconfig.xmlmsКонфігурація плитки Windows із вашим кольором плитки.
readme-makefav.txtзавждиІнструкції зі встановлення з HTML-кодом для вашого <head> у кінці.

Приклади коду

Each example uploads logo.png with a few options and saves favicons.zip, handling API errors. Set the environment variable MAKEFAV_API_KEY to your API key first.

Завантаження multipart:

# Multipart upload (recommended). --fail-with-body exits non-zero on HTTP errors
# and still saves the JSON error body, so you can inspect it.
curl --fail-with-body -sS https://makefav.com/api/v1/generate \
  -H "Authorization: Bearer $MAKEFAV_API_KEY" \
  -F "[email protected]" \
  -F "app_name=My App" \
  -F "theme_color=#2f9e68" \
  -F "radius=20" \
  -o favicons.zip \
  || { echo "Request failed:"; cat favicons.zip; rm -f favicons.zip; exit 1; }

Тіло JSON із зображенням у base64 (потрібен jq):

# JSON body with a base64-encoded image (built with jq to avoid argument length limits)
base64 < logo.png | tr -d '\n' > logo.b64
jq -n --rawfile img logo.b64 \
  '{image_base64: $img, app_name: "My App", theme_color: "#2f9e68", radius: 20}' \
| curl --fail-with-body -sS https://makefav.com/api/v1/generate \
    -H "Authorization: Bearer $MAKEFAV_API_KEY" \
    -H "Content-Type: application/json" \
    --data-binary @- \
    -o favicons.zip \
  || { echo "Request failed:"; cat favicons.zip; rm -f favicons.zip; exit 1; }

Використання в HTML

Upload all files to the folder you set with path, then paste the snippet into the <head> of every page. It is included at the end of readme-makefav.txt in the package and, with format=json, returned in the html field. Example for the options used in the code examples above:

<head>
  <meta charset="utf-8">
  <title>My App</title>

  <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
  <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
  <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
  <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
  <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
  <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
  <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
  <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
  <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
  <link rel="icon" type="image/png" sizes="192x192" href="/android-icon-192x192.png">
  <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
  <link rel="icon" type="image/png" sizes="96x96" href="/favicon-96x96.png">
  <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
  <link rel="icon" href="/favicon.ico" sizes="any">
  <link rel="manifest" href="/manifest.json">
  <meta name="msapplication-TileColor" content="#2f9e68">
  <meta name="msapplication-TileImage" content="/ms-icon-144x144.png">
  <meta name="msapplication-config" content="/browserconfig.xml">
  <meta name="theme-color" content="#2f9e68">
</head>

Після розгортання очистьте кеш браузера або відкрийте сайт у приватному вікні – браузери агресивно кешують favicon.

Журнал змін

v1

  • Перший публічний реліз REST API MakeFav.
  • Endpoints POST /generate, GET /me, GET /sizes and GET /openapi.json.
  • Формати відповіді ZIP і JSON, вхідні зображення через multipart, base64 та URL.
  • Особисті API-ключі зі 100 запитами на годину.

Версія 1 стабільна: ми лише додаємо необов’язкові параметри й поля. Зміни, що порушують сумісність, виходитимуть як нова версія із завчасним повідомленням.

Підтримка

Є запитання, повідомлення про помилки або потрібен вищий ліміт запитів? Ми з радістю допоможемо. Вкажіть у повідомленні час запиту та код помилки – але ніколи не API-ключ.