@include('sections.navigation') @include('sections.header')

راهنمای وب سرویس


این وب‌سرویس دارای متدهای گوناگون برای دریافت و ثبت اطلاعات است، در زمان استفاده از این متدها باید به پارامترهای مشخص شده در راهنما توجه کنید. در این وب‌سرویس چهارنوع پارامتر وجود دارد:
۱- Header- این پارامترها به هدر درخواست اضافه می‌شوند.
۲- Query- پارامترهای کوئری در ادامه‌ی آدرس و بعد از علامت '?' قرار می‌گیرند.
۳- Path- در بخشی از آدرس قرار می‌گیرند.
۴- Body- این نوع از پارامترها به عنوان یک خصوصیت در یک شیء Json داخل body درخواست قرار می‌گیرند.

برای استفاده از این وب‌سرویس نیاز به دریافت هیچگونه api_key ندارید اما توجه داشته باشید که اطلاعات ثبت شده توسط شما در این وب‌سرویس، بعد از 10 دقیقه از روی آن پاک می‌شود. البته برای اینکه توسعه‌دهندگان، تجربه‌ی کار با متدهایی که نیاز به Authentication دارند رو هم بدست بیارن، یکی از متدها که برای دریافت اطلاعات کاربر هست نیاز به توکن JWT دارد که باید بعد از ثبت‌نام کاربر جدید از متد لاگین بگیرید.

لیست متدهای این وب‌سرویس به شرح زیر می باشد:

@foreach($apiList as $api)

{{$api['title']}}

{{$api['description']}}

@if($api['params']) @foreach($api['params'] as $apiParam) @endforeach
  نام پارامتر نوع پارامتر توضیحات
{!! $apiParam['mandatory'] !!} {{$apiParam['name']}} {{$apiParam['type']}} {{$apiParam['description']}}
@endif

نمونه جواب این متد به شکل زیر می باشد:

{{ $api['response'] }}
@endforeach
@include('sections.goal') @include('sections.samples') @include('sections.contact') @include('sections.footer')