oveleon/contao-propstack-api-bundle

Propstack API Controller for Contao.

0.3.0 2023-12-15 11:29 UTC

Requires

• php: ^7.4 || ^8.0
• contao/core-bundle: ^4.9
• symfony/property-access: >=5.1

Requires (Dev)

• contao/manager-plugin: ^2.0

Conflicts

• contao/core: *
• contao/core-bundle: 4.4.1
• contao/manager-plugin: <2.0 || >=3.0

GPL-3.0-or-later

• Oveleon
• Daniele Sciannimanica

• api
• contao
• propstack

README

This extension serves as a bridge between Contao and the Propstack API. You can find the documentation for Propstack here. A Propstack API key is required for use.

• Access to the API can be protected
• API calls can be made both via GET (protected) and directly via PHP (unprotected)
• In-build parameter checking: only allowed parameters are passed to the API to prevent errors

Endpoints:
All currently available endpoints can be viewed here.

Example (GET):

https://example.com/api/propstack/units?key=contao_api_key

// Show all routes
https://example.com/api/propstack/help?key=contao_api_key

Example (PHP):

$objUnits = new UnitController();
$objUnits->setFormat(PropstackController::FORMAT_JSON);

$units = $objUnits->read($parameters);
$units = $objUnits->readOne($id);
$units = $objUnits->edit($id, $parameters);
$units = $objUnits->create($parameters);
$units = $objUnits->delete($id);

// Create a unit with custom fields
$objUnits->setCustomFields(['my_custom_field']);

$units = $objUnits->create([
    'title'          => 'My Unit',
    'marketing_type' => 'BUY',      
    'object_type'    => 'LIVING',
    'rs_type'        => 'APARTMENT',
    'custom_fields'  => [
        'my_custom_field' => '123'
    ]
]);