README

PLS API - MYFYBA 私有清单系统 API

安装

通过 Composer：这是您需要添加到 composer.json 文件中的内容，以自动将 src/API.php 导入到您的 vendors 文件夹

{
    "require": {
        "myfyba/pls": "dev-master"
    }
}

当然，然后您需要运行 composer update。

如何使用

注意：所有方法返回序列化的 JSON

实例化 API 类

use MyFYBA\PLS\API;

$settings = [
    'key' => 'YOUR API KEY' (String, Required), // Example: 'dcabf94ad97d6f09914c8be1a302891520a5964d'
    'id' => USER ID (Number, Required), // Example: 56
    'endpoint' => 'https://api.myfyba.org' (Optional)
];

$api = new API($settings);

示例

use MyFYBA\PLS\API;

$settings = [
    'key' => 'dcabf94ad97d6f09914c8be1a302891520a5964d',
    'id' => 56,
    'endpoint' => 'https://api.myfyba.org'
];

$api = new API($settings);

筛选船舶

方法：vessel('filter string')

$api->vessel('page=1&currency=usd&price=0,1000000');

可选的 get_filters() 方法返回完整的查询字符串，因此我们可以将上述调用重写为

$api->vessel($api->get_filters());

使用 ID 和语言过滤器获取船舶

方法：vessel(id, $api->get_filters())

$api->vessel(82, 'lang=fr');

筛选包租船舶

方法：charter('filter string')

$api->charter('page=1&currency=usd&price=0,1000000');
$api->charter($api->get_filters()); // As explained above

使用船舶 ID 和语言过滤器获取包租详情

方法：charter(id, $this->get_filters())

$api->charter(82, 'lang=fr');

获取您的经纪人详情

方法：brokerage()

$api->brokerage();

通过其 ID 获取经纪人详情

方法：brokerage(id)

$api->brokerage(5);

船舶和包租过滤器

方法：filters($resource, $filters)

$api->filters('vessel', 'lang=fr&status=On');

myfyba / pls

维护者

详细信息