API سفارشی

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

ساخت بررسی API#

1. ۱

   «بررسی جدید» را بزنید

   در بررسی‌ها دکمه‌ی بررسی جدید را بزنید و نوع بررسی را روی API سفارشی بگذارید.

2. ۲

   فیلدها را پر کنید

   فیلد	اجباری	توضیح
   آدرس API	بله	لینک کاملی که باید بررسی شود
   کد پاسخ موردانتظار	خیر؛ پیش‌فرض 200	کدی که یعنی «سالم». برای بیشتر APIها همان 200 درست است
   توکن دسترسی	خیر	اگر سرویس احراز هویت می‌خواهد، مثلاً Bearer xxxxx. این مقدار در هدر Authorization فرستاده می‌شود

3. ۳

   ذخیره کنید

   اولین بررسی ظرف چند دقیقه اجرا می‌شود. از آن به بعد هر ۵ دقیقه تکرار می‌شود، یا با کمترین فاصله‌ی پلن اگر بیشتر باشد.

چه آدرسی را پایش کنم؟#

بیشتر ارائه‌دهنده‌های پرداخت و پیامک یک آدرس مخصوص بررسی وضعیت سرویس (health یا status) دارند. همان را بگذارید، نه آدرسی که پول جابه‌جا می‌کند یا پیامک واقعی می‌فرستد؛ این درخواست هر ۵ دقیقه تکرار می‌شود.

اگر سرویس چنین آدرسی ندارد، یک درخواست سبک و بی‌ضرر انتخاب کنید؛ مثل گرفتن موجودی حساب یا اطلاعات پروفایل.

مثال: پایش پنل پیامک#

آدرس API:     https://api.sms-provider.ir/v1/account/credit
کد پاسخ:      200
توکن دسترسی:  Bearer sk_live_xxxxxxxxxxxx

اگر این آدرس مرتب با کد 200 جواب بدهد، یعنی هم سرویس پیامک بالاست و هم توکن شما هنوز معتبر است. با یک بررسی دو مشکل رایج را پوشش داده‌اید.

کی «قطع» اعلام می‌شود؟#

• کد پاسخ با کد موردانتظار یکی نباشد؛ مثلاً 401 به‌جای 200 چون توکن منقضی شده است.
• ظرف ۱۵ ثانیه پاسخی نیاید.
• اتصال برقرار نشود؛ مثلاً خطای DNS یا گواهی نامعتبر.

مثل بقیه‌ی بررسی‌ها، رخداد بعد از دو نتیجه‌ی ناموفق پشت سر هم باز می‌شود.

امنیت توکن#

توکنی که وارد می‌کنید رمزنگاری‌شده ذخیره می‌شود و بعد از ذخیره، دیگر نه در داشبورد نمایش داده می‌شود و نه در پاسخ‌های API. فقط در لحظه‌ی اجرای بررسی رمزگشایی و فرستاده می‌شود. با این حال، تا جای ممکن توکنی با کمترین دسترسی، یعنی فقط‌خواندنی، بسازید و به wardex بدهید.