oveleon / contao-propstack-api-bundle
Contao 的 Propstack API 控制器。
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
README
此扩展作为 Contao 与 Propstack API 之间的桥梁。您可以在这里找到 Propstack 的文档。使用时需要 Propstack API 密钥。
- API 访问可以受到保护
- API 调用可以通过 GET(受保护)和直接通过 PHP(不受保护)进行
- 内置参数检查:仅将允许的参数传递给 API 以防止错误
端点
所有当前可用的端点可以在这里查看:这里。
示例(GET)
https://example.com/api/propstack/units?key=contao_api_key
// Show all routes
https://example.com/api/propstack/help?key=contao_api_key
示例(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' ] ]);