شروع کار
احراز هویت
هر درخواست با کلید API حساب شما شناخته می‌شود. کلید در آدرس درخواست قرار می‌گیرد، نه در هدر؛ هدر یا توکن جداگانه‌ای لازم نیست.
گرفتن کلید
وارد پنل مشتریان، بخش کلید API شوید. کلید پنهان نمایش داده می‌شود؛ با دکمه نمایش آن را ببینید و با دکمه کپی بردارید. کلید هر حساب یکتاست و همه ارسال‌های آن از اعتبار همان حساب کم می‌شود.
قرار دادن کلید در آدرس
کلید، اولین بخش مسیر بعد از /v1/ است:
https://api.payamras.ir/v1/YOUR_API_KEY/account/info.json
برای آزمایش کلید، account/info را صدا بزنید. این متد پیامی ارسال نمی‌کند و
اعتبار باقی‌مانده حساب را برمی‌گرداند. اگر کلید اشتباه باشد، return.status برابر
403 است.
نگهداری امن کلید
- کلید را فقط در کد سمت سرور نگه دارید. کلیدی که در جاوااسکریپت مرورگر یا اپلیکیشن موبایل باشد، با چند دقیقه بررسی قابل استخراج است و هر کسی می‌تواند با اعتبار شما پیامک بفرستد.
- کلید را در متغیر محیطی یا فایل تنظیمات خارج از مخزن کد نگه دارید، نه داخل خود کد.
- چون کلید بخشی از آدرس است، در لاگ دسترسی وب‌سرور یا ابزارهای مانیتورینگ شما هم ثبت می‌شود. لاگ‌هایی را که آدرس کامل درخواست‌های خروجی را نگه می‌دارند محدود کنید.
- اگر فکر می‌کنید کلید لو رفته است، فورا با پشتیبانی تماس بگیرید تا کلید جدید برایتان صادر شود.
آزمایش بدون هزینه
با account/config و debugmode=enabled،
درخواست‌های ارسال پذیرفته می‌شوند اما پیامی ارسال نمی‌شود و اعتباری کم نمی‌شود. پیش از راه‌اندازی نهایی آن را دوباره disabled کنید. تغییر تنظیمات حساب به دسترسی IP نیاز دارد.