README

The EasyFie API PHP Client is a simple and easy-to-use library for interacting with the EasyFie API. This library provides methods to authenticate, retrieve user data, manage orders, and more.

Installation

You can install the EasyFie API PHP Client via Composer:

composer require robi/easyfieapi

Usage

Instantiate the Client

First, you need to instantiate the EasyFie class:

use EasyFie\EasyFie;

$easyFie = new EasyFie();

Get API Token

To authenticate and get an API token, use the getToken method:

$token = $easyFie->getToken('your_username', 'your_password');

Get User Profile

To retrieve the user profile data, use the Me method:

$profile = $easyFie->Me($token);

Get Web Data

To retrieve web data, use the WebData method:

$webData = $easyFie->WebData($token);

Get All Categories

To retrieve all categories, use the getAllCategories method:

$categories = $easyFie->getAllCategories($token);

Get Themes Color

To retrieve themes color, use the getThemesColor method:

$themesColor = $easyFie->getThemesColor($token);

Get Generated Pages

To retrieve generated pages, use the generatedPages method:

$generatedPages = $easyFie->generatedPages($token);

Get Single Generated Page

To retrieve a single generated page by slug, use the generatedPageSingle method:

$generatedPage = $easyFie->generatedPageSingle($token, 'your_slug');

Get Meta Data

To retrieve meta data, use the getMetaData method:

$metaData = $easyFie->getMetaData($token);

Get Products or Blogs

To retrieve products or blogs, use the ProductsOrBlogs method:

$productsOrBlogs = $easyFie->ProductsOrBlogs($token, 'products', 10, 'asc', 1);

Get Single Data

To retrieve single data by type and ID, use the SingleData method:

$singleData = $easyFie->SingleData($token, 'products', 123);

Get Single Category Data

To retrieve single category data, use the singleCategories method:

$singleCategory = $easyFie->singleCategories($token, 1, 10, 1);

Search Data

To search data by type and keyword, use the Search method:

$searchResults = $easyFie->Search($token, 'products', 'keyword', 10);

Place an Order

To place an order, use the Orders method:

$order = $easyFie->Orders($token, ['product_id' => 123, 'quantity' => 1]);

Update Order Payment Status

To update the payment status of an order, use the OrdersPayment method:

$orderPayment = $easyFie->OrdersPayment($token, 123, 'paid');

Get Notifications

To retrieve notifications, use the notify method:

$notifications = $easyFie->notify($token);

Generate Pagination

To generate pagination HTML, use the Paginate method:

$pagination = $easyFie->Paginate(1, 100, 10);

Get Portfolio Data

To retrieve portfolio data, use the Portfolio method:

$portfolio = $easyFie->Portfolio($token, 10, 'asc', 1);

Check Plugin Status

To check the status of a plugin, use the plugin_checker method:

$pluginStatus = $easyFie->plugin_checker($token, 123);

Error Handling

The library returns JSON-encoded error messages for invalid inputs or API errors. You can decode the JSON to handle errors appropriately:

$error = json_decode($easyFie->getToken('', ''));
if (isset($error->error)) {
    echo $error->error;
}

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Support

For support, please open an issue on GitHub or contact the maintainer.

This documentation should help you get started with the EasyFie API PHP Client. For more detailed information, refer to the source code and the official EasyFie API documentation.

robi / easyfieapi

Maintainers

Details