kylewlawrence / laravel-mainwp-api

为 MainWP 提供的 Laravel API

dev-main 2023-09-01 20:13 UTC

This package is auto-updated.

Last update: 2024-09-30 01:52:23 UTC


README

此包提供了与 MainWP API 的集成。目前仅支持发送聊天消息。

安装

您可以使用 Composer 安装此包

composer require kylewlawrence/laravel-mainwp-api

外观将自动安装。

MainWP::get('sites', ['per_page' => 100]);

配置

要发布配置文件到 app/config/mainwp-laravel.php,请运行

php artisan vendor:publish --provider="KyleWLawrence\MainWP\Providers\MainWPServiceProvider"

使用 环境变量 设置您的配置,可以在您的 .env 文件或服务器控制面板上设置

  • MAINWP_DOMAIN

主WP托管的完全限定域名。

  • MAINWP_CONSUMER_KEY

API访问消费者认证。您可以按照以下说明创建一个:https://kb.mainwp.com/docs/mainwp-rest-api/

  • MAINWP_CONSUMER_SECRET

与消费者密钥配对。

  • MAINWP_DRIVER (可选)

将此设置为 nulllog 以防止从您的环境中直接调用 MainWP API。

贡献

此处始终欢迎拉取请求。我很快会跟进并开发贡献指南。在此期间,只需打开一个问题或创建一个拉取请求即可。

用法

外观

MainWP 外观充当 MainWP\Http\HttpClient 类实例的包装器。

依赖注入

如果您不想使用外观,您可以将 KyleWLawrence\MainWP\Services\MainWPService 注入到您的类中。然后您可以使用此对象上的所有相同方法,就像在外观上一样。

<?php

use KyleWLawrence\MainWP\Services\MainWPService;

class MyClass {

    public function __construct(MainWPService $mainwp_service) {
        $this->mainwp_service = $mainwp_service;
    }

    public function getSites() {
        $this->mainwp_service->get('sites/all-sites');
    }

}

此包在 MIT 许可证 下可用。