REST Provider — ساختار Wizard و Rest Service

14. Provider از نوع REST

Provider از نوع REST برای اتصال به APIهای مبتنی بر HTTP/HTTPS به‌کار می‌رود. در این نوع Provider شما آدرس سرویس، متد ارسال، هدرهای موردنیاز، نحوه ارسال پارامترها، ساختار پاسخ و حتی فیلدهای محاسباتی خروجی را تعریف می‌کنید. به همین دلیل مستندسازی این بخش باید کامل باشد و تنها به یک معرفی کوتاه محدود نماند.

14.1. گام «اطلاعات منبع»

در اولین گام، نوع منبع داده روی Rest قرار می‌گیرد و عنوان منبع داده تعیین می‌شود. این عنوان نام داخلی Provider در سامانه است و در مصرف‌های بعدی مانند Form، Service Bus یا Custom JS با همین هویت قابل شناسایی خواهد بود.

14.2. گام «مدیریت Rest Service» و فیلدهای آن

این گام بخش اصلی تنظیمات REST Provider است و Contract اصلی درخواست HTTP را مشخص می‌کند. توضیح فیلدهای این مرحله به‌صورت زیر است:

14.3. Query Parameter در URL و placeholderها

یکی از بخش‌هایی که قبلاً توضیح کافی نداشت، پارامترهای Query در URL است. در خود سامانه نیز راهنما برای این موضوع وجود دارد:

برای قرار دادن متغیر، نام متغیر دلخواه را داخل علامت { } بگذارید

یعنی اگر بخواهید بخشی از URL یا Query String در زمان اجرا مقداردهی شود، باید یک placeholder داخل آکلاد قرار دهید و سپس در گام پارامترها برای همان نام، پارامتر متناظر تعریف کنید. برای مثال:

https://agent.a2a.ae/SharedApi/Login?rememberMe={rememberMeValue}

در این مثال، rememberMeValue یک پارامتر URL است. بنابراین در مرحله پارامترها باید ردیفی تعریف شود که نام پارامتر آن rememberMeValue، نوع آن مثلاً Boolean، مقدار آن مثلاً true و محل قرارگیری آن url باشد.

14.4. متد ارسال و نوع Accept

فهرست Methodهای قابل انتخاب و نیز مقادیر Accept از طریق DropDownهای همان صفحه در دسترس هستند. انتخاب صحیح این دو مورد برای سازگاری با سرویس مقصد ضروری است. برای نمونه، در سناریوهای API محور معمولاً POST به‌همراه application/json یا application/json; charset=utf-8 استفاده می‌شود.