مصرف خرید درون‌برنامه‌ای با API

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

نکته

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

امنیت

این API فقط برای فراخوانی Server to Server است. توکن X-Access-Token را در برنامهٔ کلاینت قرار ندهید.

درخواست

cURL

curl --request PUT \
  'https://developer.myket.ir/api/partners/applications/{PACKAGE_NAME}/purchases/products/{SKU_ID}/tokens/{TOKEN}/consume' \
  --header 'X-Access-Token: {ACCESS_TOKEN}'

Python

import requests

package_name = "org.example.app"
sku_id = "GEM2"
purchase_token = "PURCHASE_TOKEN"
url = (
    f"https://developer.myket.ir/api/partners/applications/{package_name}"
    f"/purchases/products/{sku_id}/tokens/{purchase_token}/consume"
)
headers = {"X-Access-Token": "YOUR_ACCESS_TOKEN"}

response = requests.put(url, headers=headers)
print(response.status_code, response.json())

پارامتر	توضیح
PACKAGE_NAME	نام پکیج برنامه
SKU_ID	شناسهٔ محصول مصرف‌شدنی
TOKEN	توکن خرید درون‌برنامه‌ای
ACCESS_TOKEN	توکن صحت‌سنجی برنامه از پنل توسعه‌دهندگان

پاسخ موفق

در صورت موفقیت، پاسخ HTTP 200 و بدنه‌ای مشابه زیر برمی‌گردد:

{
  "code": 200,
  "messageCode": "Successful",
  "translatedMessage": "عملیات با موفقیت انجام شد"
}

پاسخ‌های خطا

وضعیت	کد پیام	توضیح
400	SkuAlreadyConsumed	محصول قبلاً مصرف شده است
404	PurchasedSkuNotFound	خرید یا توکن موردنظر پیدا نشد
404	SkuIdNotFound	محصول درون‌برنامه‌ای پیدا نشد
500	InternalError	خطای داخلی سرور