مقدمه
این پروژه مرجع یکپارچه وبسرویسهای SOAP سامانه پیامک است. مستندات متدهای ارسال، دریافت، ارسال زماندار، پیام صوتی، دفترچه تلفن و ارسال هوشمند در منوی همین پروژه در دسترس هستند.
انتخاب سرویس
- وبسرویس ارسال: ارسال ساده و گروهی، اعتبار، وضعیت تحویل و متدهای ارسال با شماره خدماتی.
- وبسرویس دریافت: دریافت پیامکهای ورودی و اطلاعات صندوق دریافت.
- وبسرویس زماندار: ثبت، پیگیری و حذف ارسالهای برنامهریزیشده.
- وبسرویس صوتی: ارسال پیام صوتی و سناریوی پشتیبان صوتی پس از بررسی تحویل پیامک.
- دفترچه تلفن: مدیریت گروهها، مخاطبان و مناسبتهای مخاطب.
- وبسرویس هوشمند: ارسال با خط اصلی و دو خط پشتیبان و دریافت وضعیت تحویل.
آدرس اصلی و WSDL هر سرویس روی دستهبندی همان سرویس قرار دارد. WSDL قرارداد متدها و نوع پارامترها را برای ابزارهای تولید Client فراهم میکند. نمونههای آماده برای cURL، PHP، C#، JavaScript، Python، Java و Go در صفحه هر متد ارائه شدهاند.
احراز هویت
در متدهایی که username و password دارند، اطلاعات احراز هویت داخل بدنه SOAP ارسال میشود و نیازی به هدر Authorization نیست:
usernameنام کاربری حساب است.- در
passwordاز ApiKey بخش تنظیمات وبسرویس استفاده کنید. - متدهایی که طبق قرارداد WSDL این دو پارامتر را ندارند، بدون افزودن پارامتر یا هدر اضافی فراخوانی شوند.
ساخت و بررسی درخواست
- درخواست را با HTTPS و کدگذاری UTF-8 ارسال کنید.
- نام پارامترها و حروف کوچک و بزرگ آنها را مطابق نمونه همان متد نگه دارید.
- آرایههای متناظر باید هماندازه و با ترتیب یکسان ارسال شوند.
- محدودیت تعداد گیرندگان، بازه زمانی و سایر قواعد هر متد را پیش از ارسال بررسی کنید.
- پاسخ خام SOAP مستقل از زبان برنامهنویسی Client است؛ کتابخانه SOAP آن را به مدل همان زبان تبدیل میکند.
- بسیاری از خطاهای کاربردی داخل بدنه SOAP و با HTTP 200 برمیگردند؛ بنابراین مقدار بازگشتی متد را همیشه بررسی کنید.
ملاحظات امنیتی
- ApiKey را فقط در سرور نگه دارید و در کد مرورگر، مخزن عمومی یا Log ثبت نکنید.
- برای درخواستها Timeout، مدیریت Retry محدود و ثبت خطای بدون اطلاعات حساس در نظر بگیرید.
- دسترسی شبکه و IPهای مجاز را متناسب با محیط عملیاتی محدود کنید.
- در صورت افشای ApiKey، آن را فوراً تعویض کنید.
برای شروع، خانواده سرویس و سپس متد موردنظر را از منوی کناری انتخاب کنید. صفحه هر متد شامل ورودیها، مقدار بازگشتی، کدهای کاربردی و نمونههای فراخوانی و پاسخ است.