احراز هویت REST API
آموزش ساخت کلید محرمانه، تعیین مجوزها و ارسال درخواست احراز هویتشده به REST API اینپی فای.
هر درخواست REST API باید یک کلید محرمانه پروژه را با روش Bearer Authentication ارسال کند. کلید، پروژه و مجوزهای قابلاستفاده را مشخص میکند؛ بنابراین شناسه پروژه جداگانهای در body درخواست ارسال نمیشود.
هدرهای لازم
اگر هنوز کلید ندارید، از راهنمای ساخت کلید محرمانه و تفاوت آن با کلید SDK شروع کنید.
برای endpointهای پیشنهاد، این هدر نیز الزامی است:
X-InAppify-App-ID باید شناسه اپلیکیشنی باشد که داخل همان پروژه کلید API قرار دارد.
نمونه درخواست cURL
نمونه درخواست PHP با cURL
مجوزهای کلید
برای هر integration فقط مجوزهای موردنیاز را فعال کنید. مجوزهای REST API مستقل هستند؛ برای مثال کلیدی با customers:read اجازه حذف مشتری یا ویرایش ویژگیهای او را ندارد.
| مجوز | کاربرد |
|---|---|
customers:read | دریافت یا ایجاد مشتری |
customers:delete | حذف مشتری |
customers:attributes:write | همگامسازی ویژگیهای مشتری |
offerings:read | دریافت پیشنهادهای یک اپلیکیشن |
offerings:override:write | ثبت پیشنهاد اختصاصی مشتری |
offerings:override:delete | حذف پیشنهاد اختصاصی |
entitlements:promotional:grant | اعطای دسترسی تبلیغاتی |
entitlements:promotional:revoke | لغو دسترسیهای تبلیغاتی |
discount:generate | ساخت کد تخفیف اختصاصی |
خطاهای احراز هویت
کلید ارسال نشده یا معتبر نیست (401):
کلید معتبر است ولی مجوز endpoint را ندارد (403):
مقدار کامل کلید محرمانه فقط هنگام ساخت نمایش داده میشود. آن را در secret manager یا متغیر محیطی سرور نگه دارید و هرگز در log، repository یا پیام خطا چاپ نکنید.