پرش به مطلب اصلی

📌 به سند راهنمای IPPanel خوش آمدید

👋 سلام! اگر در IPPanel حساب کاربری دارید، به جای درستی آمده‌اید. این مستندات هر آنچه را که باید در مورد استفاده از API ما بدانید - از ارسال پیام گرفته تا مدیریت حساب کاربری و فراتر از آن - پوشش می‌دهد.

آدرس پایه​

آدرس پایه: https://edge.ippanel.com/v1

لطفاً {base_url} را با آدرس پایه واقعی سرور جایگزین کنید.

احراز هویت​

تمام نقاط پایانی API نیاز به احراز هویت با استفاده از یک توکن حامل دارند. می‌توانید این توکن را از طریق بخش Authentication دریافت کنید و یا با ورود به حساب کاربری خود در IPPanel و رفتن به قسمت برنامه نویسان-> کلیدهای دسترسی آن را دریافت نمایید.

🔑 توکن چیست؟

توکن رشته‌ای است که پس از ورود موفقیت‌آمیز کاربر با نام کاربری و رمز عبور، برای او صادر می‌شود.

  • طول توکن بین 30 تا 255 کاراکتر متغیر است.

  • هر توکن از زمان صدور به مدت ۱۰ ساعت اعتبار دارد.

  • تمام نقاط پایانی API در این مستندات با استفاده از یک توکن معتبر قابل دسترسی هستند.

🔑 کلید API چیست؟

کلید API رشته‌ای است که می‌توانید از پنل کاربری خود با رفتن به مسیر زیر تولید و دریافت کنید:

حساب کاربری > برنامه نویسان > کلید های دسترسی

  • برخلاف توکن‌ها، کلیدهای API منقضی نمی‌شوند و می‌توانند بدون محدودیت زمانی مورد استفاده قرار گیرند.

  • با این حال، همه نقاط پایانی API از کلیدهای API پشتیبانی نمی‌کنند. برخی از نقاط پایانی حساس (مثلاً تغییر رمز عبور یا ایجاد/مشاهده کلیدهای API جدید) فقط از طریق توکن قابل دسترسی هستند.

بیایید شروع کنیم​

  1. برای دریافت توکن دسترسی خود، از بخش Authentication شروع کنید.
  2. از توکن دریافت شده در هدر Authorization استفاده کنید: Authorization: your-token-or-apikey-here
  3. بخش‌های مختلف این داکیومنت را بر اساس نیازهای خود بررسی کنید

بخش های مختلف این داکیومنت​

  • 🔐 Authentication - عملیات مربوط به گرفتن ورود به سامانه(گرفتن توکن)، خروج از سامانه
  • 📨 Send SMS - ارسال پیامک با متدها و حالات مختلف
  • 📊 Reports - دریافت گزارشات ارسال و همچنین وضعیت پیام های ارسال شده
  • 📞 Numbers - مدیریت و مشاهده سرشماره ها
  • 👤 Users - مدیریت کاربران و اکانت
  • 📦 Packages - مدیریت بسته ها
  • 🎫 Ticket - سیستم پشتیبانی
  • 📝 Drafts - مدیریت پیام های پیشفرض
  • 💳 Payment - مدیریت پرداخت ها
  • 🎯 Patterns - مدیریت الگوهای ارسال یا همان پترن
  • 📁 Phonebook - مدیریت دفترچه تلفن

اصطلاحات و استاندارد ها​

منظور از فرمت E.164 برای شماره فرستنده و گیرنده بدین معناست که شماره باید با + شروع شود، پس از آن کد کشور درج میگردد(به عنوان مثال برای ایران 98) و سپس اادمه می یابد. برای گیرندگان پیام به استناد به این فرمت باید طول رشته برابر 13 کارکتر باشد.

برای شماره ارسال کننده یا همان سرشماره، طول رشته ممکن است کمتر یا بیشتر شود.

پشتیبانی​

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

همچنین می‌توانید با باز کردن یک مشکل مستقیماً در گیت هاب با تیم فنی ما تماس بگیرید.