آخرین بروزرسانی: ۱ اسفند ۱۳۹۸

راهنمای API پرس‌آنلاین

خدمات API پرس‌آنلاین مرتبط با صاحبان نظرسنجی و زیرمجموعه امکانات بپرسیم تجاری است.

مقدمه:

API پرس‌آنلاین به منظور دریافت اطلاعات نظرسنجی‌های اجرایی و پاسخ آنها برای صاحبان آن ارائه شده؛ با استفاده از این ویژگی می‌توان در هر لحظه به پاسخ‌دهندگان دسترسی داشت.
برای مثال می‌توان تعریف نمود که برای پاسخ‌دهندگان کد تخفیفی در یک فروشگاه ارائه شود و یا برای کاربرانی که هنوز پاسخ نداده اند، به صورت خودکار پیامک ارسال شود.
استفاده از API فقط برای صاحبان نظرسنجی که در پنل تجاری بپرسیم حساب کاربری دارند قابل استفاده است.

ارسال درخواست (Request):

درخواست‌های ارسالی به سمت سرور باید به نشانی https://pors.online/api/business/ باشد.
کلیه درخواست‌ها می بایست بر روی بستر SSL انجام شده تا امنیت آن تضمین گردد و همچنین درخواست‌های ارسالی باید ۳ مقدار در هدر آن قرار بگیرد:

نکته: مقدار Secret در متد Token همان مقدار اصلی بوده و در سایر متدها، توکن ارائه شده را قرار دهید.

مقادیر خروجی:

خروجی API از نوع JSON است و در صورتی که خطای بزرگی وجود نداشته باشد با نام همان متد به صورت آرایه تعریف می‌شود، در غیر اینصورت با یک کد خطای HTTP نمایانگر خواهد شد.
برای مثال می‌توان از متد test، یک خروجی را مشاهده نمود.

متدهای قابل استفاده:

با استفاده از متدهای زیر می‌توان نظرسنجی‌ها را دریافت کرده و پاسخ‌های آن‌ها را بررسی نمایید.

-دریافت توکن: token

با استفاده از این متد می‌توانید در هر زمان توکن خود را دریافت کنید، این توکن‌ها منقضی شونده اند و بعد از انقضا مجددا باید درخواست توکن نمایید. با تغییر کلید امنیتی در پروفایل کاربری، توکن‌های پیشین نیز از کار خواهد افتاد.
آدرس: https://pors.online/api/business/token

-- مقادیر ورودی ندارد
-- خروجی:
-لیست نظرسنجی‌ها: surveys

ارائه لیستی از نظرسنجی‌ها به تفکیک آرشیو، فعال بودن، غیرفعال بودن و بدون تفکیک.
آدرس: https://pors.online/api/business/surveys

-- مقادیر ورودی:
-- خروجی:
-اطلاعات یک نظرسنجی: survey

ارائه جزئیات یک نظرسنجی، نظیر مخاطبان افزوده شده، تعداد پاسخ دهندگان و سایر موارد.
آدرس: https://pors.online/api/business/survey

-- مقادیر ورودی:
-- خروجی:
-لیست پاسخ‌دهندگان به یک نظرسنجی: respondents

ارائه لیستی از پاسخ‌دهندگان به نظرسنجی با اطلاعاتی نظیر شناسه پاسخ‌دهنده، مشخصات مخاطب (در صورت وجود)، زمان پاسخ‌گویی، نوع دستگاه (وب/اپلیکیشن).
آدرس: https://pors.online/api/business/respondents

-- مقادیر ورودی:
-- خروجی:
-جستجوی یک پاسخ‌دهنده در نظرسنجی: respondent

جستجوی پاسخ‌دهنده در لیست مخاطبان پاسخ داده به یک نظرسنجی با خروجی از مشخصات پاسخ‌دهنده، زمان پاسخگویی و پاسخ پرسشنامه.
آدرس: https://pors.online/api/business/respondent

-- مقادیر ورودی:
-- خروجی:
-جستجوی یک پاسخ: response

زمانی که کاربر پس از پاسخ به نظرسنجی به سایت شما هدایت (redirect) شد، در پارامتر GET مقداری به نام response قرار داده شده که با استفاده از آن و این تابع می‌توان مشخصات پاسخ‌دهنده و پاسخ پرسشنامه را دریافت نمود.
آدرس: https://pors.online/api/business/response

-- مقادیر ورودی:
-- خروجی:
-لیست مخاطبان نظرسنجی: contacts

ارائه مخاطبان ضمیمه شده به نظرسنجی، به صورت تفکیکی فقط تایید هویت شده‌ها (پاسخ داده)، تایید هویت نشده و یا بدون تفکیک.
آدرس: https://pors.online/api/business/contacts

-- مقادیر ورودی:
-- خروجی:
-اطلاعات حساب کاربری: profile

ارائه مشخصات کاربری بر اساس کلید ارسالی، همراه با بسته فعال بر روی پنل کاربری بپرسیم تجاری.
آدرس: https://pors.online/api/business/profile

-- مقادیر ورودی:
-- خروجی:
-اطلاعات آماری: stats

ارائه آمار کلیه نظرسنجی‌های فعال، غیرفعال و آرشیو شده بر روی پرس‌آنلاین.
آدرس: https://pors.online/api/business/stats

-- مقادیر ورودی ندارد
-- خروجی:

خطاها:

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

خطاهایی که عدد آن مثبت است و یا پاسخ بدون مشکل با HTTP Response Code 200 ارسال شده و سایر خطاها به شرح زیر است: