شروع کار

کتابخانه‌ها و نمونه کلاینت

برای کار با API پیام‌رس پکیج جداگانه‌ای لازم نیست. هر متد یک درخواست HTTP است، پس چند خط کد در زبانی که استفاده می‌کنید کافی است. کلاینت‌های زیر را می‌توانید مستقیم در پروژه کپی کنید.

کلاینت آماده

هر کلاینت متد را با نام مسیرش صدا می‌زند (مثلا sms/send یا verify/lookup)، پارامترها را به‌صورت فرم ارسال می‌کند و اگر return.status برابر ۲۰۰ نباشد، خطا می‌دهد. مقدار برگشتی همان entries پاسخ است.

# ~/.bashrc یا اسکریپت استقرار
export PAYAMRAS_API_KEY="YOUR_API_KEY"

payamras() {
  # payamras sms/send receptor=09121234567 "message=سلام"
  local method="$1"; shift
  local args=()
  for p in "$@"; do args+=(--data-urlencode "$p"); done
  curl -sS -X POST "https://api.payamras.ir/v1/$PAYAMRAS_API_KEY/$method.json" "${args[@]}"
}

مدیریت خطا

  • کد خطای کلاینت همان return.status است. معنی هر کد در صفحه کدهای خطا آمده است.
  • درخواست‌های ارسال را خودکار تکرار نکنید. اگر پاسخی نرسید، ممکن است پیام ارسال شده باشد. با localid ارسال کنید و پیش از تکرار، وضعیت را با وضعیت با شناسه محلی بپرسید.
  • زمان انتظار (timeout) را محدود کنید تا قطعی شبکه، درخواست کاربر شما را معطل نکند.

نگهداری کلید

کلید را از متغیر محیطی بخوانید، نه از کد. این کلاینت‌ها فقط برای کد سمت سرور هستند؛ کلیدی که در مرورگر یا اپلیکیشن موبایل باشد قابل استخراج است. جزئیات بیشتر در احراز هویت.