احراز هویت

همهٔ سرویس‌های پیامک نجوا احراز هویت می‌خواهند و همگی از یک کلید API استفاده می‌کنند — همان کلیدی که در دریافت کلید API ساختید. تنها تفاوت، جای قرارگرفتن کلید در درخواست است که بین نسخه‌های API فرق می‌کند.

دو روش ارسال کلید#

نسخهٔ ۱ — کلید در مسیر URL#

در سرویس‌های نسخهٔ ۱، کلید API یک بخش از خودِ نشانی است و هدر احراز هویتی وجود ندارد:

curl "https://sms.najva.com/v1/YOUR_API_KEY/sms/send.json?receptor=09121234567&sender=3000XXXX&message=سلام"

نسخهٔ ۲ و ۳ — هدر Authorization#

سرویس‌های نسخهٔ ۲ و ۳ و همچنین بارگذاری فایل، کلید را از هدر استاندارد Authorization با پیشوند Bearer می‌خوانند:

curl -X POST "https://sms.najva.com/v2/sms/send" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sender":"3000XXXX","receivers":["09121234567"],"message":"سلام"}'

نام هدر دقیقاً Authorization و مقدار آن Bearer + کلید است. فاصلهٔ بین Bearer و کلید الزامی است.

پاسخ‌های خطای احراز هویت#

نمونهٔ پاسخ وقتی کلید نامعتبر است:

{
  "return": {
    "status": 403,
    "message": "کد شناسائی API-Key معتبر نمی‌باشد"
  },
  "entries": []
}

پیش از نخستین درخواست#

۱. کلید API را بسازید — دریافت کلید API ۲. آی‌پی سرورتان را ثبت کنید — وایت‌لیست IP ۳. نسخهٔ API موردنظرتان را انتخاب کنید و کلید را طبق جدول بالا در درخواست بگذارید.