اطلاعات وب سرویس

مقدمه

به راهنمای وب سرویس‌ ابر سپهر خوش آمدید. این مستندات جهت آسانی استفاده شما از سرویس‌های ابر سپهر جمع آوری شده‌اند. در صورت بروز هر گونه سوال با تیم فنی ابر سپهر از طریق تیکت در تماس باشید. همکاران ما در اسرع وقت پاسخگوی شما خواهند بود.

لطفا قبل از پیاده‌سازی به نکات زیر توجه نمایید:

API‌ های ابر سپهر RESTful می‌باشند و درخواست‌ها و پاسخ‌ها به صورت JSON رد و بدل می‌شوند.

Code تمامی درخواست‌های موفق، 200 و تمامی درخواست‌های نامعتبر 400 و خطاهای داخلی سرویس ابر سپهر 500 می‌باشد که در این صورت شما می‌توانید با توجه به message و result و بررسی پارامترهای ارسالی، علت بروز خطا را دریابید.

همچنین در صورت بروز هرگونه خطا در احراز هویت، Code پاسخ ارسالی برابر با 401 خواهد بود. در این صورت، صحت مقدار token و IP وارد شده در تنظیمات کاربری را بررسی کنید.

ابر سپهر تنها به درخواست‌هایی که از طرف IP های اعلامی شما ارسال شوند پاسخ خواهد داد. در صورت دریافت هر گونه خطا از جانب ابر سپهر، پس از بررسی مقادیر ارسالی خود، این خطا را به همراه مقادیر ارسالی و مقادیر پاسخ‌ دریافتی را برای ما ارسال کنید.

تیم فنی ابر سپهر از طریق بخش پشتیبانی سایت، پاسخگوی شما خواهد بود.

احراز هویت

ابر سپهر، از طریق هدر Authorization جهت احراز هویت درخواست‌ها استفاده می‌کند.

Authorization: Bearer {{TOKEN}}

شما میتوانید با مراجعه به حساب کاربری، تنظیمات وب سرویس، برای فعال سازی API برای حساب کاربری خود و دریافت token اقدام کنید همچنین در این بخش با افزودن IP سرور خود به لیست آی‌پی های مجاز می‌توانید به وب سرویس دسترسی داشته باشید.

مهم: با ایجاد هر token، مقدار قبلی غیرفعال شده و دیگر قابل استفاده نیست.

{
    "status": "error",
    "code": 1004,
    "message": "Invalid token"
}