API ارزدیجیتال
Englishورودثبت‌نام
API ارزدیجیتال

کلید شما

دریافت پلن، موجودی و محدودیت‌های کلید

GEThttps://api.arzdigital.com/v1/key/info
X-API-Key در هدراعتبار چطور کار می‌کند

رایگان است. با موجودی صفر و حتی پس از پایان پلن هم پاسخ می‌دهد تا همیشه بتوانید بفهمید چرا درخواست‌هایتان رد می‌شود. این درخواست در سقف دقیقه‌ای حساب می‌شود.

مصرف اعتبار: این درخواست رایگان است.

پاسخ خالی و هر نوع خطا هزینه‌ای ندارد.

پارامترها

این درخواست پارامتری ندارد.

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

  • X-API-Keystringالزامی

    کلید API شما. آن را در هر درخواست در این هدر بفرستید. کلید در نشانی درخواست پذیرفته نمی‌شود.

پاسخ

کلید، پلن، موجودی و محدودیت‌ها. مقدار X-Credits-Charged برابر 0 است.
فیلدهای پاسخ (20)
  • statusstring
  • dataobject
  • data.keyobject
  • data.key.prefixstring
    پیشوند ۸ نویسه‌ای و قابل‌نمایش کلید.
  • data.key.namestring | null
  • data.key.statusstring
  • data.planobject
  • data.plan.codestring
  • data.plan.namestring
  • data.creditsobject
  • data.credits.balanceinteger
    موجودی فعلی. ممکن است منفی باشد.
  • data.credits.allowanceinteger
    اعتبار هر دوره.
  • data.credits.reset_atstring
    زمان شارژ بعدی موجودی.
  • data.limitsobject
  • data.limits.requests_per_minuteinteger
  • data.limits.history_depth_daysinteger | null
    تعداد روزهای تاریخچه‌ای که پلن اجازه می‌دهد. null یعنی کل تاریخچه.
  • data.limits.max_keysinteger
  • data.subscriptionobject
  • data.subscription.statusstring
  • data.subscription.ends_atstring | null
    اگر پلن تاریخ پایان نداشته باشد، null است.

هدرهای پاسخ

  • X-Credits-Charged
    اعتباری که این درخواست مصرف کرد. برای هر پاسخی غیر از ۲۰۰، مقدارش 0 است.
  • X-Credits-Remaining
    موجودی حساب پس از این درخواست، بدون احتساب اعتباری که درخواست‌های هنوز در حال اجرا کنار گذاشته‌اند. فقط وقتی منفی است که حساب پس از یک اصلاح دستی بدهکار باشد.
  • X-RateLimit-Limit
    تعداد درخواست مجاز این کلید در هر دقیقه.
  • X-RateLimit-Remaining
    تعداد درخواستی که در بازه فعلی باقی مانده است.
  • X-RateLimit-Reset
    زمانی که دوباره جا برای درخواست باز می‌شود، به ثانیه یونیکس.

خطاها

  • invalid_keyerror_code 1002
    کلید فرستاده نشده، قالبش درست نیست یا چنین کلیدی وجود ندارد.

خطاها هیچ‌وقت هزینه ندارند. خطاها