Laravel

مستندات API و دانلود کالکشن Postman

دانلود نسخه Postman

مستندات API — پا به پا

مستندات بر اساس کالکشن Postman پروژه. برای تست سریع، فایل کالکشن را از دکمه بالای صفحه دانلود کنید.

Categories

List

مورد مقدار
Method GET
URL {{base_url}}/categories

Create

مورد مقدار
Method POST
URL {{base_url}}/categories
Body form-data
فیلد نوع توضیح
title text اجباری
slug text اجباری
parent_id text اختیاری
image file اختیاری
description text اختیاری
status text اجباری

Update

مورد مقدار
Method PUT
URL {{base_url}}/categories/{id}
Body form-data
فیلد نوع توضیح
title text اجباری
slug text اجباری
parent_id text اختیاری
image file اختیاری
description text اختیاری
status text اجباری

Delete

مورد مقدار
Method DELETE
URL {{base_url}}/categories/{id}

Profiles

List

مورد مقدار
Method GET
URL {{base_url}}/profiles

Create

مورد مقدار
Method POST
URL {{base_url}}/profiles
Body form-data
فیلد نوع توضیح
type text اجباری — 1=person / 2=place
image file اختیاری
name text اجباری
slug text اجباری
bio text اختیاری
phone text اختیاری
category_ids[0] text اجباری (آرایه دسته‌ها)
category_ids[1] text اختیاری
address[address] text برای مکان اجباری
address[place_id] text برای مکان اجباری
social_media[0][icon] text مقدار key از API شبکه‌های اجتماعی
social_media[0][url] text لینک شبکه اجتماعی
social_media[1][icon] text اختیاری
social_media[1][url] text اختیاری

Update

مورد مقدار
Method PUT
URL {{base_url}}/profiles/{id}
Body form-data
فیلد نوع توضیح
type text اجباری — 1=person / 2=place
image file اختیاری
name text اجباری
slug text اجباری
bio text اختیاری
phone text اختیاری
category_ids[0] text اجباری
category_ids[1] text اختیاری
address text برای مکان اجباری
place_id text برای مکان اجباری
social_media[0][icon] text مقدار key از API شبکه‌های اجتماعی
social_media[0][url] text لینک شبکه اجتماعی
social_media[1][icon] text اختیاری
social_media[1][url] text اختیاری

Delete

مورد مقدار
Method DELETE
URL {{base_url}}/profiles/{id}

Data

Social networks

مورد مقدار
Method GET
URL {{base_url}}/social-networks

لیست آیکون‌های شبکه‌های اجتماعی. مقدار key برگشتی برای فیلد social_media[*][icon] در پروفایل استفاده می‌شود.

Places

مورد مقدار
Method GET
URL {{base_url}}/places

لیست مکان‌ها (برای address[place_id] در ساخت پروفایل از نوع مکان).