API ساخت کد تخفیف

ساخت کد تخفیف اختصاصی و یک‌بارمصرف برای مشتری با REST API اینپی فای همراه پارامترها و پاسخ.

این endpoint برای یک تخفیف فعال و یک مشتری، کد اختصاصی می‌سازد. فراخوانی دوباره با همان discount_identifier_key و app_user_identifier همان کد موجود را فعال و برمی‌گرداند.

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

ساخت کد تخفیف مشتری

پارامترهای درخواست

{
  "discount_identifier_key": "welcome_offer",
  "app_user_identifier": "customer_123"
}
پارامترنوعمحدودیت
discount_identifier_keystringالزامی، حداکثر ۱۰۰ کاراکتر، شناسه تخفیف فعال در همان پروژه
app_user_identifierstringالزامی، حداکثر ۱۵۰ کاراکتر
فاصله ابتدا و انتهای هر دو مقدار پیش از اعتبارسنجی حذف می‌شود.

نمونه cURL

curl -X POST "https://api.example.com/api/v1/services/generate-discount" \
  -H "Authorization: Bearer YOUR_SECRET_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "discount_identifier_key":"welcome_offer",
    "app_user_identifier":"customer_123"
  }'

پاسخ موفق

{
  "status": true,
  "data": {
    "code": "DC-A1B2C3"
  }
}
کد ایجادشده برای همان تخفیف و مشتری یکتا، فعال و دارای سقف یک بار استفاده است.سقف یک بار استفاده برای کد جدید تعیین می‌شود. بازگرداندن کد موجود، تعداد استفاده یا محدودیت‌های قبلی آن را بازنشانی نمی‌کند؛ فراخوانی مجدد برای کد مصرف‌شده، یک فرصت خرید تازه ایجاد نمی‌کند.

خطاها

وضعیتدلیل
422یکی از پارامترها وجود ندارد، رشته نیست یا طول مجاز را رد کرده است.
403کلید مجوز discount:generate ندارد.
500تخفیف پیدا نشده یا فعال نیست، یا خطای پیش‌بینی‌نشده رخ داده است.