API برای توسعه‌دهندگان

احراز هویت

در پیشخوان، بخش API، یک کلید بسازید و آن را در سرآیند Authorization به شکل Bearer بفرستید. کلید را مثل رمز عبور نگه دارید.

curl https://avintools.ir/api/v1/links \
  -H "Authorization: Bearer avk_…"

سقف درخواست: 120 درخواست در دقیقه برای هر کلید. سقف‌های پلن (تعداد کیو آر پویا، لینک و بازهٔ آمار) در API هم اعمال می‌شود.

نقاط دسترسی

نشانی پایه: https://avintools.ir/api/v1

• GET/linksفهرست لینک‌های کوتاه
• POST/linksساخت لینک کوتاه
• GET/links/{id}دریافت یک لینک
• PATCH/links/{id}تغییر مقصد، عنوان یا توقف لینک (نشانی کوتاه ثابت می‌ماند)
• DELETE/links/{id}حذف لینک
• GET/qrفهرست کیو آر کدها
• POST/qrساخت کیو آر کد ایستا یا پویا
• GET/qr/{id}دریافت یک کیو آر کد
• PATCH/qr/{id}تغییر محتوا یا طراحی (کد پویا همان کد چاپ‌شده می‌ماند)
• DELETE/qr/{id}حذف کیو آر کد
• GET/qr/{id}/svgتصویر SVG ساده‌ی کد
• GET/analytics/{id}آمار اسکن و کلیک یک لینک یا کیو آر پویا

نمونه‌ها

ساخت لینک کوتاه

curl -X POST https://avintools.ir/api/v1/links \
  -H "Authorization: Bearer avk_…" \
  -H "Content-Type: application/json" \
  -d '{"destination":"https://example.com/sale","title":"Sale"}'

ساخت کیو آر کد پویا

curl -X POST https://avintools.ir/api/v1/qr \
  -H "Authorization: Bearer avk_…" \
  -H "Content-Type: application/json" \
  -d '{"type":"url","values":{"url":"https://example.com/menu"},"mode":"dynamic","name":"Menu"}'

تغییر مقصد کیو آر پویا (کد چاپ‌شده تغییر نمی‌کند)

curl -X PATCH https://avintools.ir/api/v1/qr/QR_ID \
  -H "Authorization: Bearer avk_…" \
  -H "Content-Type: application/json" \
  -d '{"values":{"url":"https://example.com/new-menu"}}'

خطاها

پاسخ خطا همیشه JSON با یک کد ثابت و پیام انگلیسی است: 400 درخواست نادرست، 401 کلید نامعتبر، 403 پلن بدون API یا رسیدن به سقف پلن، 404 پیدا نشد، 429 درخواست زیاد.

{ "error": { "code": "plan_limit", "message": "Plan limit reached: dynamicQr." } }

توضیح کامل API به فرمت OpenAPI: /api/v1/openapi.json