REST API · v1

MakeFav API dokumentacija

Generirajte potpune pakete favicona iz vlastitog koda, build skripti i CI cjevovoda. Jedan zahtjev pretvara bilo koju sliku u favicon.ico, Apple touch ikone, Android i PWA ikone, web manifest i HTML spreman za lijepljenje.

Na ovoj stranici

Brzi početak

MakeFav API je jednostavan REST API preko HTTPS-a i JSON-a. Svi endpointi nalaze se pod jednim osnovnim URL-om:

https://makefav.com/api/v1
  1. Izradite besplatan račun
    Registrirajte se, potvrdite svoju adresu e-pošte i zadržite aktivnu pretplatu na MakeFav newsletter – to je jedini uvjet besplatnog paketa.
  2. Izradite API ključ
    Otvorite stranicu API ključeva u svom računu i izradite osobni ključ. Počinje s mf_ i prikazuje se samo jednom, stoga ga sigurno pohranite. Upravljanje API ključevima
  3. Pošaljite svoj prvi zahtjev
    Učitajte sliku na endpoint za generiranje i spremite vraćenu ZIP datoteku:
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.

Autentifikacija

Svaki zahtjev prema zaštićenom endpointu mora sadržavati osobni API ključ. Ključeve možete bilo kada izraditi, imenovati i opozvati na stranici svog računa: API ključevi

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
Ključevi pripadaju korisniku čija je adresa e-pošte potvrđena i čija je pretplata na newsletter aktivna (uvjet besplatnog paketa). Ako e-pošta nije potvrđena, newsletter je isključen ili je račun blokiran, svaki zahtjev vraća 403 Forbidden.
API ključeve tretirajte kao lozinke: čuvajte ih na poslužitelju ili u CI tajnama, nikada u kodu preglednika, mobilnim aplikacijama ili javnim repozitorijima. Ako ključ procuri, odmah ga opozovite.

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

Ograničenja zahtjeva

Prema zadanim postavkama svaki API ključ smije slati 100 zahtjeva na sat. Svaki autentificirani odgovor pokazuje vam trenutno stanje:

ZaglavljeOpis
X-RateLimit-LimitMaksimalan broj zahtjeva dopuštenih u trenutnom razdoblju.
X-RateLimit-RemainingPreostali zahtjevi u trenutnom razdoblju.
X-RateLimit-ResetUnix vremenska oznaka (sekunde, UTC) kada se razdoblje resetira.
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.

Endpointi

EndpointAutentifikacijaOpis
POST /generateAPI ključIzradi potpuni paket favicona.
GET /meAPI ključVaš račun i trenutni status ograničenja zahtjeva.
GET /sizesNemaPopis svih datoteka ikona i veličina koje generator izrađuje.
GET /openapi.jsonNemaOpenAPI 3.1 specifikacija strojno čitljiva.

Generiraj paket favicona

POST/generate

Izrađuje potpuni paket favicona iz jedne izvorne slike. Sliku možete poslati na jedan od tri načina:

Vrsta sadržajaPolje slikeOpis
multipart/form-dataimagePrijenos datoteke. Preporučeno – najučinkovitija opcija.
application/jsonimage_base64Base64-encoded image, either raw base64 or a data URL such as data:image/png;base64,iVBOR….
application/jsonimage_urlJavni http ili https URL slike. Poslužitelj je preuzima (maks. 10 MB).

Podržani ulazni formati: PNG, JPG, WebP, AVIF, GIF, BMP, SVG i ICO. Maksimalna veličina datoteke: 10 MB.

Parametri

Svi parametri su neobavezni. Pošaljite ih kao polja obrasca (multipart) ili kao JSON svojstva. Neispravne vrijednosti zamjenjuju se zadanima.

ImeTip / rasponZadanoOpis
app_namestring, maks. 60 znakovaMy WebsiteNaziv vaše web stranice ili aplikacije, koristi se u manifest.json i na primjeru stranice.
short_namestring, maks. 24 znakaprvih 12 znakova app_nameKratki naziv prikazan ispod ikone na početnim zaslonima Androida.
theme_color#rrggbb#ffffffBoja korisničkog sučelja preglednika (theme-color meta oznaka i manifest).
tile_color#rrggbbisto kao theme_colorBoja pozadine pločica Windows Start izbornika.
backgroundtransparent | #rrggbbtransparentPozadina ikona za preglednik, Android i Windows.
apple_background#rrggbb#ffffffPozadina Apple touch ikona i maskable ikone (iOS ne podržava prozirnost). Zanemaruje se kada je pozadina boja – tada se koristi ta boja.
paddingcijeli broj, 0–40 (%)0Prazan prostor oko slike, kao postotak veličine ikone.
radiuscijeli broj, 0–50 (%)0Zaobljeni rubovi. 50 daje krug. Ne primjenjuje se na Apple ikone jer ih iOS sam zaobljuje.
zoomcijeli broj, 50–400 (%)100Mjerilo slike unutar ikone. Vrijednosti iznad 100 obrezuju sliku.
offset_x, offset_ybroj, od -1 do 10Pomiče sliku vodoravno / okomito, kao dio veličine ikone.
pathstring/Mapa na vašem poslužitelju u kojoj će se nalaziti ikone. Koristi se u HTML isječku, manifestu i datoteci browserconfig.
displaystandalone | fullscreen | minimal-ui | browserstandalonePWA način prikaza zapisan u manifest.
pixelatedauto | 1 | 0autoOštro skaliranje najbližeg susjeda za pixel art. Opcija auto uključuje ga za izvore od 64 px ili manje.
maskable1 | 01Izradi i maskable-icon-512x512.png s unutarnjim razmakom sigurne zone za prilagodljive Android ikone.
ico_sizespopis odvojen zarezima: 16, 24, 32, 48, 64, 128, 25616,32,48Veličine ugrađene u favicon.ico.
groupspopis odvojen zarezima: favicon, apple, android, msfavicon,apple,android,msSkupovi ikona za generiranje: favicon za preglednike, Apple touch ikone, Android / PWA ikone i Windows pločice.
formatzip | jsonzipFormat odgovora – pogledajte ispod.

Odgovor

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.

Primjer zahtjeva – multipart, ZIP odgovor

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>

Primjer zahtjeva – JSON s URL-om slike, JSON odgovor

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…"}
  ]
}

Dohvati svoj račun

GET/me

Vraća korisnika kojem pripada API ključ i trenutačno stanje ograničenja zahtjeva. Korisno za provjeru ključa. Zahtijeva autentifikaciju; bez parametara.

Primjer zahtjeva

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

Primjer odgovora

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

Popis veličina ikona

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.

Primjer zahtjeva

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

Primjer odgovora

{
  "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 specifikacija

GET/openapi.json

Vraća OpenAPI 3.1 opis ovog API-ja. Bez autentifikacije. Uvezite ga u Postman, Insomnia ili Swagger UI ili ga upotrijebite za generiranje tipiziranog klijenta za svoj jezik.

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

Pogreške

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 statusKod pogreškeZnačenje
400bad_requestZahtjev je neispravan, na primjer nije poslana slika ili je JSON tijelo neispravno.
401unauthorizedAPI ključ nedostaje ili je neispravan.
403forbiddenE-adresa vlasnika ključa nije potvrđena, pretplata na newsletter je isključena ili je račun blokiran.
413file_too_largeSlika je veća od 10 MB.
415unsupported_typeVrsta datoteke ili vrsta sadržaja zahtjeva nije podržana.
422invalid_imageDatoteku nije bilo moguće dekodirati kao sliku ili URL slike nije bilo moguće preuzeti.
429rate_limitedPreviše zahtjeva. Pričekajte do X-RateLimit-Reset.
500server_errorDošlo je do pogreške na našoj strani. Pokušajte ponovno kasnije; ako se nastavi, obratite se podršci.

Izlazne datoteke

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

DatotekaVeličinaGrupa
favicon.ico16, 32, 48 (podesivo)uvijek
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

Dodatne datoteke

DatotekaUključenoOpis
favicon.svgSamo za SVG ulaz bez obrezivanja, zumiranja, razmaka, zaobljenih rubova ili pozadineOčišćena kopija vašeg SVG-a za preglednike koji podržavaju vektorske favicone.
manifest.json, site.webmanifestandroidWeb app manifest za Android i PWA aplikacije koje se mogu instalirati (dvije identične kopije).
browserconfig.xmlmsKonfiguracija Windows pločica s bojom vaše pločice.
readme-makefav.txtuvijekUpute za instalaciju s HTML kodom za vaš <head> na kraju.

Primjeri koda

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 prijenos:

# 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 tijelo sa slikom kodiranom u base64 (zahtijeva 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; }

Upotreba u HTML-u

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>

Nakon objave očistite predmemoriju preglednika ili otvorite stranicu u privatnom prozoru – preglednici agresivno spremaju favicone u predmemoriju.

Popis promjena

v1

  • Prvo javno izdanje MakeFav REST API-ja.
  • Endpoints POST /generate, GET /me, GET /sizes and GET /openapi.json.
  • ZIP i JSON formati odgovora, multipart, base64 i URL kao ulaz slike.
  • Osobni API ključevi sa 100 zahtjeva na sat.

Verzija 1 je stabilna: dodajemo samo neobavezne parametre i polja. Promjene koje narušavaju kompatibilnost izdat će se kao nova verzija uz prethodnu obavijest.

Podrška

Pitanja, prijave grešaka ili trebate veće ograničenje zahtjeva? Rado ćemo pomoći. U poruku navedite vrijeme zahtjeva i kod pogreške – nikada svoj API ključ.