→ بازگشت به صفحه اصلی

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

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

🔑 مدیریت کلیدهای API

💳 کیف پول

📦 محصولات

🧪 تست آنلاین API

درخواست واقعی به /api/v1 — همان مسیری که کد شما استفاده می‌کند. در حالت آزمایشی همهٔ اعتبارسنجی‌ها (کلید، محصول، نام، موبایل، کد ملی) انجام می‌شود ولی هزینه‌ای کسر نمی‌شود و سندی تولید نمی‌شود.

حالت آزمایشی (رایگان)

درخواست

پاسخ

کلید شما فقط در همین صفحه و در حافظهٔ مرورگر شما استفاده می‌شود و جایی ذخیره نمی‌شود.

🧩 SDK — کتابخانهٔ اتصال

کلاینت تک‌فایلی برای زبان دلخواه‌تان — کپی یا دانلود کنید، bd_live_XXXX را با کلید خودتان و PRODUCT_ID را با شناسهٔ محصول (تب «محصولات») جایگزین کنید. هر سه SDK از حالت آزمایشی (testIdempotency-Key و انتظار برای آماده‌شدن سند پشتیبانی می‌کنند.


        

💰 تعرفه‌ها

پرداخت به ازای هر درخواست — بدون اشتراک ماهانه. مبالغ به تومان:

عملیاتشرحهزینه هر درخواست
در حال دریافت تعرفه‌ها…

درخواست‌های ناموفق (خطای سرور) به‌صورت خودکار برگشت داده می‌شوند. لینک دانلود تا ۷۲ ساعت معتبر است.

🚀 شروع سریع

  • ۱ — با حساب فروشنده وارد شوید و از تب کنسول یک کلید API بسازید.
  • ۲ — شناسه محصول خود را از GET /api/v1/products بگیرید.
  • ۳ — برای هر مشتری یک درخواست stamp بفرستید و لینک دانلود را تحویل بگیرید.
  • 💡 قبل از اتصال واقعی، با "test": true (یا تب تست آنلاین) درخواست‌تان را رایگان اعتبارسنجی کنید.
curl -X POST "https://buydocs.ir/api/v1/products/PRODUCT_ID/stamp" \
  -H "Authorization: Bearer bd_live_XXXXXXXXXXXX" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: my-order-1001" \
  -d '{
    "first_name": "علی",
    "last_name": "رضایی",
    "phone_number": "09123456789",
    "national_code": "0012345678"
  }'

پاسخ (201):

{
  "document_id": "d3f1c2...",
  "status": "processing",
  "download_url": "https://buydocs.ir/api/v1/documents/d3f1c2.../download?exp=...&sig=...",
  "expires_epoch": 1780000000,
  "charged": 45000
}

لینک download_url را به مشتری بدهید؛ تا آماده‌شدن سند، پاسخ 202 با هدر Retry-After برمی‌گردد و سپس فایل PDF دانلود می‌شود. برای دانلود نیازی به کلید API نیست — لینک امضاشده و زمان‌دار است.

📚 مرجع Endpoint ها

احراز هویت: هدر Authorization: Bearer bd_live_...

Endpointشرحهزینه
GET /api/v1/pricingتعرفه‌های فعلی (بدون احراز هویت)رایگان
GET /api/v1/productsفهرست محصولات آمادهٔ شمارایگان
POST /api/v1/products/{id}/stampتولید سند واترمارک‌شده برای مشتری شماطبق تعرفه
GET /api/v1/documents/{id}وضعیت سندرایگان
GET /api/v1/documents/{id}/downloadدانلود با لینک امضاشده (بدون کلید)رایگان

بدنهٔ درخواست stamp

فیلدنوعتوضیح
first_nameالزامینام — فقط حروف فارسی
last_nameالزامینام خانوادگی — فارسی، حداقل ۳ حرف
phone_numberالزامیموبایل ۱۱ رقمی با 09 (ارقام فارسی هم پذیرفته می‌شود)
national_codeشرطیکد ملی ۱۰ رقمی — اگر برای محصول «الزامی» شده باشد باید ارسال شود؛ در صورت ارسال روی سند درج می‌شود
verify_shahkarاختیاریاستعلام تطبیق کد ملی و موبایل (شاهکار) پیش از تولید سند — هزینهٔ جداگانه
testاختیاریحالت آزمایشی: اعتبارسنجی کامل درخواست بدون کسر هزینه و بدون تولید سند — پاسخ 200 با would_charge و وضعیت موجودی

هدرها

  • Idempotency-Key (پیشنهادی): شناسهٔ سفارش خودتان. تکرار همان درخواست (مثلاً بعد از قطعی شبکه) سند قبلی را برمی‌گرداند و هزینهٔ دوباره کسر نمی‌شود.

کدهای خطا

کدمعنی
401کلید API ارسال نشده / نامعتبر / باطل‌شده
402موجودی کیف پول کافی نیست
404محصول یا سند یافت نشد
409محصول در حال پردازش است / عدم انطباق شاهکار
422خطای اعتبارسنجی ورودی (نام، موبایل، کد ملی)
429عبور از سقف نرخ درخواست — هدر Retry-After را رعایت کنید
202سند هنوز آماده نیست (روی لینک دانلود) — کمی بعد دوباره تلاش کنید
410سند منقضی یا ناموفق — فایل حذف شده است

❓ نکات مهم

  • سندها با همان موتور واترمارک بایداکس تولید می‌شوند: نام، موبایل و در صورت ارسال، کد ملی مشتری روی صفحات درج و اثر انگشت دیجیتال ثبت می‌شود.
  • فایل تولیدشده و لینک آن پس از انقضا حذف می‌شوند — لینک را به‌موقع تحویل مشتری دهید.
  • اگر تولید سند به هر دلیلی شکست بخورد، مبلغ به‌صورت خودکار به کیف پول برمی‌گردد (فیلد refunded).
  • برای پشتیبانی فنی از صفحهٔ تماس با ما پیام بدهید.