اولین ارسال تا تایید
شروع سریع
یک مسیر کوتاه برای گرفتن کلید، ارسال OTP، تایید کد و خواندن وضعیت.
ورود به حساب
شروع کار از صفحه ورود انجام می شود. پس از ورود، داشبورد حساب برای اتصال حساب ارسال و ساخت کلید در دسترس است.
صفحه ورودجای تصویر: صفحه ورود یا ثبت نام نویدا
اتصال حساب
در بخش حساب ها، حداقل یک حساب پیام رسان یا sms.ir برای ارسال ثبت می شود. شناسه هر حساب بعدا در فیلد account_id قابل استفاده است.
جای تصویر: اضافه کردن حساب ارسال در داشبورد
ساخت کلید API
در بخش کلیدهای API، کلید زنده یا تست ساخته می شود. کلید زنده برای ارسال واقعی است و کلید تست برای سندباکس استفاده می شود. هنگام ساخت کلید، زمان انقضا هم می تواند مشخص شود؛ کلید منقضی یا حذف شده در درخواست های API پذیرفته نمی شود.
کلید تست با مسیرهای /v1/sandbox/otp کار می کند. کلید زنده با مسیرهای /v1/otp کار می کند.
جای تصویر: ساخت API key در داشبورد، نوع کلید و تاریخ انقضا
ارسال
برای ارسال زنده، هدر Idempotency-Key ضروری است. مقدار آن برای هر تلاش منطقی ارسال یکتا باشد.
curl -X POST https://api.navidaa.ir/v1/otp/send \
-H "X-API-Key: navidaa_live_xxx" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: login-09123456789-1700000000" \
-d '{"phone":"09123456789","channels":["eitaa","sms"]}'
import requests
response = requests.post(
"https://api.navidaa.ir/v1/otp/send",
headers={
"X-API-Key": "navidaa_live_xxx",
"Content-Type": "application/json",
"Idempotency-Key": "login-09123456789-1700000000",
},
json={"phone": "09123456789", "channels": ["eitaa", "sms"]},
timeout=10,
)
print(response.json())
تایید
curl -X POST https://api.navidaa.ir/v1/otp/verify \
-H "X-API-Key: navidaa_live_xxx" \
-H "Content-Type: application/json" \
-d '{"verification_id":"550e8400-e29b-41d4-a716-446655440000","code":"123456"}'
import requests
response = requests.post(
"https://api.navidaa.ir/v1/otp/verify",
headers={
"X-API-Key": "navidaa_live_xxx",
"Content-Type": "application/json",
},
json={
"verification_id": "550e8400-e29b-41d4-a716-446655440000",
"code": "123456",
},
timeout=10,
)
print(response.json())
وضعیت
curl https://api.navidaa.ir/v1/otp/550e8400-e29b-41d4-a716-446655440000 \ -H "X-API-Key: navidaa_live_xxx"
import requests
response = requests.get(
"https://api.navidaa.ir/v1/otp/550e8400-e29b-41d4-a716-446655440000",
headers={"X-API-Key": "navidaa_live_xxx"},
timeout=10,
)
print(response.json())