REST API · v1

MakeFav API ডকুমেন্টেশন

আপনার নিজের কোড, বিল্ড স্ক্রিপ্ট ও CI পাইপলাইন থেকে সম্পূর্ণ ফেভিকন প্যাকেজ তৈরি করুন। একটি অনুরোধেই যেকোনো ছবি favicon.ico, Apple touch icon, Android ও PWA আইকন, ওয়েব ম্যানিফেস্ট এবং কপি-পেস্টের জন্য প্রস্তুত HTML-এ রূপান্তরিত হয়।

এই পৃষ্ঠায়

দ্রুত শুরু

MakeFav API একটি সহজ HTTPS + JSON REST API। সব এন্ডপয়েন্ট একটি বেস 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-Resetউইন্ডো রিসেট হওয়ার Unix টাইমস্ট্যাম্প (সেকেন্ড, 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 কীএকটি সম্পূর্ণ ফেভিকন প্যাকেজ তৈরি করুন।
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 URL। সার্ভার এটি ডাউনলোড করে (সর্বোচ্চ ১০ MB)।

সমর্থিত ইনপুট ফরম্যাট: PNG, JPG, WebP, AVIF, GIF, BMP, SVG এবং ICO। সর্বোচ্চ ফাইল সাইজ: ১০ MB।

প্যারামিটার

সব প্যারামিটার ঐচ্ছিক। এগুলো ফর্ম ফিল্ড (multipart) বা JSON প্রপার্টি হিসেবে পাঠান। ভুল মান দিলে ডিফল্ট মান ব্যবহৃত হবে।

নামটাইপ / রেঞ্জডিফল্টবিবরণ
app_nameস্ট্রিং, সর্বোচ্চ ৬০ অক্ষরMy Websiteআপনার ওয়েবসাইট বা অ্যাপের নাম, manifest.json ও উদাহরণ পেজে ব্যবহৃত হয়।
short_nameস্ট্রিং, সর্বোচ্চ ২৪ অক্ষরapp_name-এর প্রথম ১২ অক্ষরAndroid হোম স্ক্রিনে আইকনের নিচে দেখানো সংক্ষিপ্ত নাম।
theme_color#rrggbb#ffffffব্রাউজার UI-এর রং (theme-color মেটা ট্যাগ ও manifest)।
tile_color#rrggbbtheme_color-এর মতোইWindows Start টাইলের ব্যাকগ্রাউন্ড রং।
backgroundtransparent | #rrggbbtransparentব্রাউজার, Android ও Windows আইকনের ব্যাকগ্রাউন্ড।
apple_background#rrggbb#ffffffApple touch আইকন ও maskable আইকনের ব্যাকগ্রাউন্ড (iOS স্বচ্ছতা সমর্থন করে না)। background কোনো রং হলে এটি উপেক্ষা করা হয় – সেক্ষেত্রে ওই রংটিই ব্যবহৃত হয়।
paddingপূর্ণসংখ্যা, ০–৪০ (%)0ইমেজের চারপাশের ফাঁকা জায়গা, আইকন সাইজের শতাংশ হিসেবে।
radiusপূর্ণসংখ্যা, ০–৫০ (%)0গোলাকার কোণ। ৫০ দিলে বৃত্ত হয়। Apple আইকনে প্রযোজ্য নয়, কারণ iOS নিজেই সেগুলো গোলাকার করে।
zoomপূর্ণসংখ্যা, ৫০–৪০০ (%)100আইকনের ভেতরে ইমেজের স্কেল। ১০০-এর বেশি মান ইমেজ ক্রপ করে।
offset_x, offset_yসংখ্যা, -১ থেকে ১0আইকন সাইজের ভগ্নাংশ হিসেবে ইমেজকে অনুভূমিকভাবে / উল্লম্বভাবে সরায়।
pathস্ট্রিং/আপনার সার্ভারের যে ফোল্ডারে আইকনগুলো থাকবে। HTML স্নিপেট, manifest ও browserconfig-এ ব্যবহৃত হয়।
displaystandalone | fullscreen | minimal-ui | browserstandalonemanifest-এ লেখা PWA ডিসপ্লে মোড।
pixelatedauto | 1 | 0autoপিক্সেল আর্টের জন্য ধারালো nearest-neighbour স্কেলিং। auto মোডে ৬৪ px বা তার ছোট সোর্সের জন্য এটি চালু হয়।
maskable1 | 01Android অ্যাডাপটিভ আইকনের জন্য সেফ-জোন প্যাডিংসহ maskable-icon-512x512.png-ও তৈরি করুন।
ico_sizesকমা দিয়ে আলাদা করা তালিকা: 16, 24, 32, 48, 64, 128, 25616,32,48favicon.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>

উদাহরণ রিকোয়েস্ট – ইমেজ URL সহ JSON, 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ইমেজ ১০ MB-এর চেয়ে বড়।
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 ইনপুটের জন্য, ক্রপ, জুম, প্যাডিং, কোণ বা ব্যাকগ্রাউন্ড ছাড়াভেক্টর favicon সমর্থনকারী ব্রাউজারের জন্য আপনার SVG-র স্যানিটাইজড কপি।
manifest.json, site.webmanifestandroidAndroid ও ইনস্টলযোগ্য PWA-র জন্য ওয়েব অ্যাপ manifest (দুটি অভিন্ন কপি)।
browserconfig.xmlmsআপনার টাইল রংসহ Windows টাইল কনফিগারেশন।
readme-makefav.txtসবসময়শেষে আপনার <head>-এর জন্য HTML কোডসহ ইনস্টলেশন নির্দেশনা।

কোড উদাহরণ

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; }

base64-এনকোড করা ইমেজসহ JSON বডি (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

  • MakeFav REST API-এর প্রথম পাবলিক রিলিজ।
  • Endpoints POST /generate, GET /me, GET /sizes and GET /openapi.json.
  • ZIP ও JSON রেসপন্স ফরম্যাট, multipart, base64 এবং URL ইমেজ ইনপুট।
  • ঘণ্টায় ১০০ রিকোয়েস্টসহ ব্যক্তিগত API কী।

ভার্সন ১ স্থিতিশীল: আমরা শুধু ঐচ্ছিক প্যারামিটার ও ফিল্ড যোগ করব। ব্রেকিং পরিবর্তন আগে থেকে জানিয়ে নতুন ভার্সন হিসেবে প্রকাশ করা হবে।

সহায়তা

প্রশ্ন, বাগ রিপোর্ট বা বেশি রেট লিমিট দরকার? আমরা সাহায্য করতে প্রস্তুত। আপনার বার্তায় রিকোয়েস্টের সময় ও এরর কোড উল্লেখ করুন – কখনোই আপনার API কী নয়।