magical/php-rest-api

magiCal REST API 的 PHP 客户端

v2.0.0 2019-10-28 13:38 UTC

This package is auto-updated.

Last update: 2024-09-29 01:18:14 UTC


README

此仓库包含 magiCal REST API 的开源 PHP 客户端。文档可以在以下地址找到: https://www.magic-calendar.com/docs

需求

  • 注册 免费magiCal账号
  • 创建一个新的 API_TOKEN
  • magical PHP API 客户端需要 PHP >= 5.4。

安装

运行 Composer 命令安装最新稳定的 MagiCal 版本

composer require magical/php-rest-api

安装后,您需要引入 Composer 的自动加载器

require 'vendor/autoload.php';

用法

  • 必需
    • API_TOKEN - 是您独特的 magiCal 日历的标识符。
    • SECRET_TOKEN - 是用于 API 通信的唯一身份验证标识符。
  • 可选
    • DYNAMIC_TOKEN - 如果您使用 动态计划,您可以在一个网站上拥有多个日历。
\Magical\MagiCal::setSecretToken('st_DUzEYJoX2jacJkKHvMrL7CEZyJX1bVs');
\Magical\MagiCal::setApiToken('at_FAjxXZC5yOh7QCeOd3jgpXAVRlQtIaR');
\Magical\MagiCal::setDynamicToken('dt_kEr41T'); // only if you are using dynamic plan

这很简单。现在我们可以查询服务器。要创建预订,您需要先创建客户并设置预订日期。客户所需的信息包括:名字、姓氏、电子邮件和成人数量。让我们来预订

$customer = new \Magical\Objects\Customer([
    'person_title' => 'mr', // values = ['mr', 'mrs', 'ms'] 
    'first_name' => 'John',
    'last_name' => 'Doe',
    'email' => 'john.doe@mail.com',
    'adults' => 2,
    'children' => 1,
    'phone' => '0123456789',
    'description' => '' 
]);

\Magical\Objects\Reservation::setDates('2019-10-05', '2019-10-09');
$response = \Magical\Objects\Reservation::create($customer);

if($response->success) {
    // See $response->reservation for details
} else {
    // Handle validation errors
    if($response->code === 422) {
        // See $response->errors for details
    }
    // Handle error
    else {
        // See $response->message for details
    }
}

文档

完整的文档、说明和示例可在以下地址找到:https://www.magic-calendar.com/docs

许可

MIT