Extending API with a New Entity in Venddor IO

In the Venddor IO environment, if you intend to enhance the API with a fresh module entity, a systematic approach is required. Here's a step-by-step guide to help you through this process:

• Directory Structure: Start by establishing a Tygh/Api/Entities subdirectory within your module's main directory. The path should resemble: app/addons/<module_name>/Tygh/Api/Entities.
• Entity File Creation: Inside the Tygh/Api/Entities subdirectory, you must generate a file representing the new entity. As an illustration, let's name it Things.php. So, if you're working on the "My Modifications" module, the entity's path would look like: app/addons/my_modifications/Tygh/Api/Entities/Things.php.
• Class Definition: Within this file, you need to articulate a class with an identical name (Things in this instance). This class should inherit properties from the core Api\Entity class and be a part of the Tygh\Api\Entities namespace. It's essential for this class to incorporate all four core CRUD methods.

Template for Your Entity Class:

namespace Tygh\Api\Entities;

use Tygh\Api\AEntity;
use Tygh\Api\Response;

class Things extends AEntity
{
    public function index($id = '', $params = array())
    {
        return array(
            'status' => Response::STATUS_OK,
            'data' => array()
        );
    }
    
    public function create($params)
    {
        return array(
            'status' => Response::STATUS_CREATED,
            'data' => array()
        );
    }
    
    public function update($id, $params)
    {
        return array(
            'status' => Response::STATUS_OK,
            'data' => array()
        );
    }
    
    public function delete($id)
    {
        return array(
            'status' => Response::STATUS_NO_CONTENT,
        );
    }
    
    public function privileges()
    {
        return array(
            'create' => 'create_things',
            'update' => 'edit_things',
            'delete' => 'delete_things',
            'index'  => 'view_things'
        );
    }
}

Incorporating Extra Methods:

privilegesCustomer(): This method empowers you to specify the permissions for unauthorized users interfacing with this API entity. By default, these users cannot access the API.

To grant API access for unauthorized users, a slight modification in the config.local.php file, located in your store's root directory, is needed: Modify 'api_allow_customer' => false, to 'api_allow_customer' => true,.

public function privilegesCustomer()
{
    return array(
        'index' => true
    );
}

Both the privileges() and privilegesCustomer() methods give you the flexibility to employ true or false, as illustrated in the provided example.

By following this structure, you can seamlessly extend the capabilities of the Venddor IO platform, integrating new entities into its API, ensuring that your modules are both efficient and versatile.