soomedia/floorplanner-v2

Floorplanner API v2 的 PHP 客户端

v4.0.2 2022-06-22 07:56 UTC

README

Build Status

Floorplanner v2

PHP 客户端,用于 Floorplanner API v2

要求

API 客户端需要 PHP 版本 8.1。

安装

使用 Composer 安装此包

composer require soomedia/floorplanner-v2

使用方法

客户端是 Floorplanner API 的简单包装,您可以像使用 API 一样使用它

require 'vendor/autoload.php';

$client = new \SooMedia\Floorplanner\FloorplannerClient('your_api_key');

$response = $client->projects()->create([
    'project' => [
        'name' => 'My new house',
        'description' => 'This is my first floor plan',
        'external_identifier' => 'ID3344',
        'project_template_attributes' => [
            'template_id' => 10,
        ],
    ],
]);

/*
[
    'id' => 170280,
    'user_id' => 103,
    'public' => false,
    'name' => 'My new house',
    'description' => 'This is my first floor plan',
    'project_url' => '2fv03b',
    'created_at' => '2017-03-23T15:48:19.000Z',
    'updated_at' => '2017-03-23T15:48:19.000Z',
    'enable_autosave' => false,
    'external_identifier' => 'ID3344',
    'exported_at' => null,
]
*/

如果您想更改使用的基准 URI,可以将它作为客户端构造函数的第二个参数提供

$client = new \SooMedia\Floorplanner\FloorplannerClient(
    'your_api_key',
    'https://sandbox.floorplanner.com/'
);

实现端点

以下是对 API 端点实现的概述以及实现可用的版本。