API توسعه‌دهندگان کافه‌بازار

معرفی

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

لازم به ذکر است که همهٔ توسعه‌دهندگان کافه‌بازار نیاز به استفاده از این API ندارند. در اکثر موارد شما می‌توانید به طور مستقیم از پنل توسعه‌دهندگان بازار برای مدیریت خریدهای کاربران و وضعیت اشتراک آن‌ها استفاده کنید. با این حال، اگر تعداد زیادی برنامه و محصول دارید، برای پیگیری این موارد، ممکن است این API برایتان سودمند باشد.

این API به شما این امکان را می‌دهد که با ارسال یک درخواست GET استاندارد از سمت سرور خود، جزئیات اشتراک‌ها و خریدهای درون‌برنامه‌ای خود را دریافت کنید. در این درخواست، شما اطلاعات یک خرید (نام بسته، شناسه محصول یا اشتراک و Token خرید) را ارسال می‌کنید و سرور با یک شئ از نوع JSON شامل جزئیات خرید (وضعیت سفارش، Developer Payload و اطلاعات دیگر) به درخواست شما پاسخ می‌دهد.

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

برای استفاده از این API باید ابتدا فرآیند Authorization را برای سرور خود انجام دهید. با انجام این فرآیند، به API دسترسی پیدا خواهید کرد.

کافه‌بازار برای فرآیند Authorization، از پروتکل OAuth 2.0 استفاده می‌کند. برای استفاده از API توسعه‌دهندگان شما باید ابتدا اقدام به ساخت Client در پنل پرداخت بازار کنید، و سپس با استفاده از اطلاعات Client خود، access_code دریافت کنید. access_code توکنی است که باید همراه با هر درخواست به API فرستاده شود.

هر یک از امکانات API از طریق یک درخواست HTTP در دسترس خواهد بود. پاسخ هر یک از این درخواست‌ها، اطلاعات و نتایج درخواستی، و با خطای اتفاق افتاده در سرور کافه‌بازار، در قالب JSON است. برای اطلاع بیشتر از امکانات، و پاسخ‌های آن‌ها، به مرجع API در ادامه این مستندات مراجعه کنید.

هر توسعه‌دهنده می‌تواند در روز ۵۰٫۰۰۰ درخواست از API داشته باشد. در صورتی که به میزان بیشتری درخواست نیاز دارید، با واحد پشتیبانی توسعه‌دهندگان بازار تماس بگیرید.