API Documentation

EasyUp Multipurpose Website CMS - API

The API provides all modules data of the CMS. Page, blog, job, category, product, search, form, menu & subscriber data could be access with these API.

Version: 1.0

Created: 12 September, 2023

Page Data - GET

Get a page's data:

{{BASE_URL}}/api/get-req-data/page-data

Query Parameters

Field	Type	Description
type	string	id/slug/type Required
value	String	Page ID / Page Slug / Type ID Required
image	String	Option: yes/no Optional - default: no. If yes, return page image information
post	String	Option: yes/no Optional - default: no. If yes, return page post information
file	String	Option: yes/no Optional - default: no. If yes, return page file information
gallery	String	Option: yes/no Optional - default: no. If yes, return page gallery information & images

Child Page Data - GET

Get all child pages data of a parent page :

{{BASE_URL}}/api/get-req-data/child-pages

Query Parameters

Field	Type	Description
page_id	Integer	Parent page ID Required
image	String	Option: yes/no Optional - default: no. If yes, return child page image information
post	String	Option: yes/no Optional - default: no. If yes, return child page post information
file	String	Option: yes/no Optional - default: no. If yes, return child page file information
gallery	String	Option: yes/no Optional - default: no. If yes, return child page gallery information & images
sections	String	Option: yes/no Optional - default: no. If yes, return all sections data of child pages

Post Data - GET

Get page post data :

{{BASE_URL}}/api/get-req-data/page-post-data

Query Parameters

Field	Type	Description
page_id	Integer	Parent Page ID / Section ID Required
type	String	Option: page/slug/type default: page
value	String	Post Slug / Post Type ID Optional : When type is page Required: When type is slug/type
limit	Integer	Optional - default: 999

Page & Sections Data - GET

Get page & it's section page data :

{{BASE_URL}}/api/get-req-data/sections

Query Parameters

Field	Type	Description
type	string	id/slug/type Required
value	String	Page ID / Page Slug / Type ID Required
get_section	String	Option: yes/no Optional - default: no. If yes, return sections information
image	String	Option: yes/no Optional - default: no. If yes, return page image information
post	String	Option: yes/no Optional - default: no. If yes, return page post information
file	String	Option: yes/no Optional - default: no. If yes, return page file information
gallery	String	Option: yes/no Optional - default: no. If yes, return page gallery information & images

Search Data - GET

String search result data :

{{BASE_URL}}/api/get-req-data/search

Query Parameters

Field	Type	Description
keyword	String	Required Search string. Example: Software

Global Settings Data - GET

Get all global settings data :

{{BASE_URL}}/api/get-req-data/settings-data

Blog List - GET

Get all blog data :

{{BASE_URL}}/api/get-req-data/blog-list

Query Parameters

Field	Type	Description
category_id	Integer	Optional blog Category ID for filter category wise

Blog Details - GET

Get blog details information & images :

{{BASE_URL}}/api/get-req-data/blog-data

Query Parameters

Field	Type	Description
type	string	id/slug Required
value	String	Blog ID / Blog Slug Required

Job List - GET

Get all job information:

{{BASE_URL}}/api/get-req-data/job-list

Query Parameters

Field	Type	Description
category_id	Integer	Optional Job Category ID for filter category wise

All Category - GET

Get all category list with type wise filter :

{{BASE_URL}}/api/get-req-data/all-category

Query Parameters

Field	Type	Description
type	Integer	Optional Value: 1 = Blog, 2 = Career, 3 = Product Type wise filter category

Category Data - GET

Get a category details information :

{{BASE_URL}}/api/get-req-data/category-data

Query Parameters

Field	Type	Description
type	string	id/slug Required
value	String	Category ID/Category Slug Required
image	String	Option: yes/no Optional - default: no. If yes, return category image information

Child Categories - GET

Get child categories information :

{{BASE_URL}}/api/get-req-data/child-category

Query Parameters

Field	Type	Description
category_id	Integer	Parent Category ID Required
image	String	Option: yes/no Optional - default: no. If yes, return child categories image information

Product Data - GET

Get a product information :

{{BASE_URL}}/api/get-req-data/product-data

Query Parameters

Field	Type	Description
type	string	id/slug Required
value	String	Product ID / Product Slug Required
image	String	Option: yes/no Optional - default: no. If yes, return product image information
post	String	Option: yes/no Optional - default: no. If yes, return product post information
file	String	Option: yes/no Optional - default: no. If yes, return product file information
specification	String	Option: yes/no Optional - default: no. If yes, return product specification information
gallery	String	Option: yes/no Optional - default: no. If yes, return product gallery information & images
variation	String	Option: yes/no Optional - default: no. If yes, return product variation information

All Featured Product - GET

Get all featured product information :

{{BASE_URL}}/api/get-req-data/all-featured-products

Query Parameters

Field	Type	Description
image	String	Option: yes/no Optional - default: no. If yes, return product image information
post	String	Option: yes/no Optional - default: no. If yes, return product post information
file	String	Option: yes/no Optional - default: no. If yes, return product file information
specification	String	Option: yes/no Optional - default: no. If yes, return product specification information
gallery	String	Option: yes/no Optional - default: no. If yes, return product gallery information & images
variation	String	Option: yes/no Optional - default: no. If yes, return product variation information

All Products - GET

Get all product information :

{{BASE_URL}}/api/get-req-data/all-products

Query Parameters

Field	Type	Description
image	String	Option: yes/no Optional - default: no. If yes, return product image information
post	String	Option: yes/no Optional - default: no. If yes, return product post information
file	String	Option: yes/no Optional - default: no. If yes, return product file information
specification	String	Option: yes/no Optional - default: no. If yes, return product specification information
gallery	String	Option: yes/no Optional - default: no. If yes, return product gallery information & images
variation	String	Option: yes/no Optional - default: no. If yes, return product variation information
limit	Integer	(optional - default: 999)

Products by Category - GET

Get all product information by category :

{{BASE_URL}}/api/get-req-data/product-by-category

Query Parameters

Field	Type	Description
category_id	Integer	Category ID Required
image	String	Option: yes/no Optional - default: no. If yes, return product image information
post	String	Option: yes/no Optional - default: no. If yes, return product post information
file	String	Option: yes/no Optional - default: no. If yes, return product file information
specification	String	Option: yes/no Optional - default: no. If yes, return product specification information
gallery	String	Option: yes/no Optional - default: no. If yes, return product gallery information & images
variation	String	Option: yes/no Optional - default: no. If yes, return product variation information

Form Fields - GET

Get all fields of a dynamic form :

{{BASE_URL}}/api/get-req-data/form-fields

Query Parameters

Field	Type	Description
form_id	String	Form ID Required

Form Submit - POST

To get all product of a category call the following URL :

{{BASE_URL}}/api/post-req-data/form-submit

Query Parameters

Field	Type	Description
spam_protector	string	It will be a hidden field in form. If a form submitted with data in this field, that form will not save in database and treat as spam.
form_id	String	Form ID Required
name	String	Demo form field Required/Optional based of dynamic form fields rule
phone	String	Demo form field Required/Optional based of dynamic form fields rule
email	String	Demo form field Required/Optional based of dynamic form fields rule
message	String	Demo form field Required/Optional based of dynamic form fields rule
file	File	Demo form field Required/Optional based of dynamic form fields rule

Add Subscriber - POST

Submit subscriber form :

{{BASE_URL}}/api/post-req-data/add-subscriber

Query Parameters

Field	Type	Description
spam_protector	string	It will be a hidden field in form. If a form submitted with data in this field, that form will treat as spam & not save in database.
email	String	Email Address Required

Menu by ID - GET

Get a menu information :

{{BASE_URL}}/api/post-req-data/menu-data

Query Parameters

Field	Type	Description
menu_id	Integer	Menu ID Required

Response Code

The API uses the following response code:

Response Code	Meaning
200	The request has succeeded
400	Some parameters are missing. This error appears when you don't pass every mandatory parameters. Or during get or submit data, model has validation issue.
403	Forbidden / unauthorized access API
404	No data found
500	Internal server error

Admin Panel Documentation

Documentaion