README

Maileon 合作伙伴 API 客户端

提供连接到 XQueue Maileon 的合作伙伴 REST API 的 API 客户端，并将所有 API 功能和数据序列化，以便在 PHP 项目中更易于使用。

Maileon 的 REST API 文档可在以下位置找到：这里。

目录

• 需求
• 安装
• 使用
• 示例
• 测试

需求

API 客户端需要 PHP >= 8.1 和 libcurl。

此外，所有请求都使用 SSL 加密的 API 端点。为了在 CURL 中启用 SSL 支持，请按照以下步骤操作

1. 从 https://curl.haxx.se/ca/cacert.pem 下载 CURL 的官方 SSL 证书包
2. 将包保存到可以被您的 PHP 安装访问的目录
3. 将以下条目添加到您的 php.ini 文件中（请记住更改证书包的路径）

curl.cainfo="your-path-to-the-bundle/cacert.pem"

安装

您可以使用 Composer 将此库添加到您的项目中

composer require xqueue/maileon-partner-api-client

使用

API 客户端将 Maileon 的合作伙伴 REST API 的功能划分为特定的可消费服务。每个服务提供其特定类别的所有功能。

• AccountService

  • 管理时事通讯和客户账户、API 密钥、邮件域名。

• BlacklistService

  • 管理您的黑名单。

• ContingentService

  • 管理预备役和预付费状态。

• DistributorReportService

  • 获取数量和 SMS 报告。

• GeneralService

  • 获取域名列表、验证域名、获取地区。

• JobService

  • 获取作业、创建账户作业。

• ProductService

  • 管理产品和上传模板。

• ReportService

  • 获取报告检查和报告 CSA。

• RoleService

  • 创建或删除自定义角色。

• UserService

  • 管理用户账户和角色。

• WebhookService

  • 管理 webhook。

示例

获取时事通讯账户

$service = new AccountService(['API_KEY' => 'Your API key'])

$response = $service->getNewsletterAccounts();

if(!$response->getResponse()->isSuccess()){
    // handle error
}

$newsletterAccounts = $response->getData();

创建作业

$service = new JobService(['API_KEY' => 'Your API key'])

$response = $this->jobService->createAccountJob(
            $locale,
            $type,
            $author,
            $customerAccountName,
            $newsletterAccountName,
            $customDomain ?? null,
            $providedDomain ?? null,
            $subdomain ?? null,
            $customDns ?? null,
            $accountTemplateId ?? null,
            $users ?? null,
            $customerAccountId ?? null,
            $domainAsLogin ?? null
        );

if(!$response->getResponse()->isSuccess()){
    // handle error
}

$data = $response->getData();
$jobId = $data['jobId'];

测试

为了运行单元测试，您需要安装 Docker。

首先，您需要创建一个 .env 文件并添加您的 API 密钥

MAILEON_PARTNER_API_KEY=**********

运行以下命令以创建容器并安装所需的包

docker-compose up -d

docker exec -it partner-api composer install 

运行以下命令以运行测试

docker exec -it partner-api composer test
docker exec -it partner-api composer test-coverage  // or this if you want to have the coverage generated