مرجع REST API اینپی فای
مرجع کامل REST API سروربه‌سرور اینپی فای شامل احراز هویت، endpointها، پارامترها، پاسخ‌ها، خطاها و نمونه کد PHP.
REST API اینپی فای برای ارتباط امن سرور شما با منابع یک پروژه طراحی شده است. با این API می‌توانید مشتری را دریافت یا ایجاد کنید، ویژگی‌های او را تغییر دهید، پیشنهاد فعال را بخوانید یا بازنویسی کنید، حق دسترسی تبلیغاتی بدهید و کد تخفیف اختصاصی بسازید.
کلید محرمانه REST API را داخل اپلیکیشن موبایل، وب‌سایت عمومی یا کد سمت کاربر قرار ندهید. درخواست‌ها باید از بک‌اند شما ارسال شوند.
اطلاعات پایه
| مورد | مقدار |
|---|---|
| Base URL | https://api.example.com/api/v1 |
| قالب داده | application/json |
| احراز هویت | Authorization: Bearer YOUR_SECRET_API_KEY |
| نسخه فعلی | v1 |
| محدودیت هر کلید | ۱۲۰ درخواست در دقیقه و ۲۰٬۰۰۰ درخواست در روز |
| محدودیت ترکیب کلید و IP | ۳۰۰ درخواست در دقیقه |
دامنه نمونه را با دامنه API اعلام‌شده در پنل اینپی فای جایگزین کنید.
فهرست endpointها
| عملیات | متد و مسیر | مجوز لازم |
|---|---|---|
| دریافت یا ایجاد مشتری | GET /subscribers/{app_user_id} | customers:read |
| حذف مشتری | DELETE /subscribers/{app_user_id} | customers:delete |
| ثبت، ویرایش یا حذف ویژگی‌ها | POST /subscribers/{app_user_id}/attributes | customers:attributes:write |
| دریافت پیشنهادها | GET /subscribers/{app_user_id}/offerings | offerings:read |
| تعیین پیشنهاد اختصاصی | POST /subscribers/{app_user_id}/offerings/{offering_identifier}/override | offerings:override:write |
| حذف پیشنهاد اختصاصی | DELETE /subscribers/{app_user_id}/offerings/override | offerings:override:delete |
| اعطای حق دسترسی تبلیغاتی | POST /subscribers/{app_user_id}/entitlements/{entitlement_identifier}/promotional | entitlements:promotional:grant |
| لغو حق دسترسی تبلیغاتی | POST /subscribers/{app_user_id}/entitlements/{entitlement_identifier}/revoke_promotionals | entitlements:promotional:revoke |
| ساخت کد تخفیف مشتری | POST /services/generate-discount | discount:generate |
مسیر پیشنهادی مطالعه
- احراز هویت و ساخت درخواست
- قرارداد پاسخ‌ها و خطاها
- API مشتریان و ویژگی‌ها
- API پیشنهادها
- API حق دسترسی تبلیغاتی
- API ساخت کد تخفیف
- نمونه اتصال با PHP
REST API پنل، API ادمین و endpointهای داخلی SDK بخشی از این قرارداد عمومی نیستند. برای اتصال داخل اپلیکیشن، راهنمای SDK را ببینید.