README

PHP实现Wix API作为SDK。

安装

composer require chkltlabs/wix-client

用法

此包的使用故意非常基础，方法没有必需的输入，除非底层Wix API需要。请参阅Wix API文档获取更多信息。

此包仅使用API密钥进行了测试。请参阅下面的路线图以了解计划中的功能。

首先，实例化Wix类。根据您计划访问的端点，您可以将其中一个account_id/site_id设置为空字符串（但不能同时设置两个）。

use Chkltlabs\WixClient\Wix;

$api = new Wix(api_key: $my_api_key, account_id: $my_account_id, site_id: $my_site_id);

现在您有了基于类的各种API资源的访问器。这些资源被视为Wix类的属性，或这些属性的属性。

//get all posts on the site's blog
$response = $api->blog->posts->list();

此结构旨在尽可能忠实地复制Wix API文档。

路线图

已实现

• 博客
• • 分类
  • 草稿
  • 帖子
  • 标签
• 商业
• • 位置
  • 属性
• 评论
• 联系人
• • 批量
  • 扩展字段
  • 分面
  • 标签
• 优惠券
• • 批量
• 收件箱
• • 对话
  • 消息

即将到来

• 营销
• 媒体
• 成员
• 站点内容
• 自动化
• 预订
• 聊天
• 数据
• 事件
• 表单
• 论坛
• 群组
• 通知
• 类方法 -> 路由文档

未计划

• 收银员
• 电子商务
• 忠诚度计划
• 支付
• 定价计划
• 餐厅
• 商店
• 支付服务提供商SPI
• 账户管理

贡献

此包使用基于AbstractResource构建的统一请求系统，因此贡献新的端点就像在src/Resources中创建一个新类一样简单，创建更进一步的子类就像创建一个与您的类名匹配的新目录一样简单，并将HasCachedResources特质添加到您的父类中。确保每个都扩展AbstractResource。

来自Blog.php的示例

//src/Resources/Blog.php
<?php

namespace Chkltlabs\WixClient\Resources;

use Chkltlabs\WixClient\Traits\HasCachedResources;

class Blog extends AbstractResource
{
    use HasCachedResources;
}

//src/Resources/Blog/Posts.php
<?php

namespace Chkltlabs\WixClient\Resources\Blog;

use Chkltlabs\WixClient\Resources\AbstractResource;

class Posts extends AbstractResource
{
    public function list(array $params = []): object
    {
      //...
    }
  //...
}

致谢

此包深受TomorrowIdeas/Plaid SDK实现的启发和影响。去给他们一些爱吧！