ساخت QR Code معرفی API نسخه عمومی

این API یک سرویس ساده و سریع برای تولید QR Code به‌ صورت آنلاین است که بدون نیاز به نصب افزونه یا کتابخانه خاص، در تمام سایت ها و پروژه ها قابل استفاده می باشد. خروجی API یک تصویر PNG استاندارد با پس زمینه شفاف است و می توان از آن در هر جایی که امکان استفاده از آدرس تصویر وجود دارد (وب، موبایل، ایمیل، PDF و چاپ) استفاده کرد.

این سرویس به‌ صورت عمومی و مستقل در سایت ایکس وانی ارائه شده و نیازی به احراز هویت ندارد.

 

آدرس API:

https://qr.x1i.ir/v1

 

نحوه استفاده

کافی است پارامتر data را از طریق متد GET ارسال کنید.
خروجی به‌صورت تصویر PNG برگردانده می‌شود.

مثال ساده

https://qr.x1i.ir/v1?data=https://example.com

 

پارامترها

data (اجباری)
متنی یا لینکی که باید به QR Code تبدیل شود
نوع: string

size (اختیاری)
اندازه خروجی QR Code (به پیکسل)
نوع: number
پیش‌فرض: 250
بازه مجاز: 100 تا 1000

مثال:

size=150

 

لوگو

logo (اختیاری)
URL لوگو
نوع: string

مثال:

?https://qr.x1i.ir/v1?data=https://example.com&logo=https://example.ir/img/logo.png
 

 

تک رنگ

color (اختیاری)

رنگ QR Code به‌صورت HEX بدون #
نوع: string
پیش‌فرض: 000000 (مشکی)

مثال:

color=007aff
 

نمونه تک رنگ

https://qr.x1i.ir/v1?size=300&color=007aff&data=https://example.com

 

رنگ گرادینت

from (اختیاری)

رنگ شروع گرادینت (HEX بدون #)
نوع: string
پیش‌فرض: 591b84

to (اختیاری)

رنگ پایان گرادینت (HEX بدون #)
نوع: string
پیش‌فرض: 9b35d9

مثال:

https://qr.x1i.ir/v1?data=https://example.com&from=007aff&to=00c853


 

 

نمونه درخواست کامل

 

https://qr.x1i.ir/v1?size=300&from=007aff&to=00c853&data=https://example.com


 

خروجی API

فرمت: image/png

رنگ QR: مشکی

پس‌زمینه: شفاف

قابل کش شدن توسط مرورگر و CDN

 

نمونه درخواست (Raw)

GET https://qr.x1i.ir/v1?size=150&data=https://example.com

 

نمونه استفاده در وردپرس (صرفاً مثال)

<img
 src="https://qr.x1i.ir/v1?size=200&data=<?php echo urlencode(get_permalink()); ?>"
 alt="QR Code for <?php the_title(); ?>"
>

 

HTML

 <img
 src="https://qr.x1i.ir/v1?size=200&data=https://example.com"
 width="200"
 height="200"
 alt="QR Code"
/>

 

استفاده در JavaScript

const url = encodeURIComponent(window.location.href);

const img = document.createElement('img');
img.src = `https://qr.x1i.ir/v1?size=200&color=000000&data=${url}`;
document.body.appendChild(img);

 

استفاده در PHP پروژه‌ها

$qr = 'https://qr.x1i.ir/v1?size=250&data=' . urlencode($link);

 

JS / React

 <img
 src={`https://qr.x1i.ir/v1?size=200&data=${encodeURIComponent(url)}`}
 width={200}
 height={200}
 alt="QR Code"
/>
 

 

قوانین استفاده

استفاده عمومی مجاز است

ارسال درخواست بیش‌ از حد ممکن است محدود شود

مسئولیت محتوای data بر عهده استفاده‌ کننده است

Cache فعال

 

موارد استفاده

سایت‌های وردپرسی (بدون افزونه)

قالب‌های اختصاصی

فریم‌ورک‌ها (Laravel، React، Next و …)

اپلیکیشن‌های موبایل

صفحات دانلود، معرفی، تبلیغات

لینک‌سازی و اشتراک‌گذاری

 

سازگاری

این API با تمام سیستم‌ها و فریم‌ ورک‌ ها سازگار است، از جمله:

HTML و JavaScript

WordPress

Laravel و سایر فریم‌ ورک‌ های PHP

اپلیکیشن‌ های موبایل

ایمیل‌ های HTML

 

نکات مهم

مقدار data باید URL Encode شود

حداکثر اندازه پیشنهادی تصویر: 500

این API برای استفاده عمومی طراحی شده است

لوگو وسط QR قرار می‌گیرد فرمت PNG

 

خطاها

400      پارامتر data ارسال نشده

400     مقدار size خارج از بازه مجاز

400     فرمت رنگ نامعتبر

500     خطای داخلی سرور