README

许可证

本软件在以下许可证条款下发布

MIT许可证（MIT）

特此免费许可，任何获得本软件及其相关文档副本（“软件”）的人均可不受限制地处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本，并允许向提供软件的人提供此类许可，前提是遵守以下条件

包内容

解压缩分发后的.zip文件后，您将在提取的文件夹中看到以下元素

client/                   - the client code
doc/                      - the API documentation
test/                     - the testing app and the phphunit tests
CHANGELOG                 - The changelog file
LICENSE						 - a copy of the MIT license this software is released under
README.md                 - this file
build.properties          - the build configuration
build.xml                 - the ant build file
phpunit-configuration.xml - the phpunit configuration file

访问文档

将您的浏览器指向doc/index.html。

安装测试应用程序

您需要一个具有有效PHP安装的Web服务器。如果您在Windows上开发，XAMPP是一种提供此类环境的简单方法。

接下来，在您喜欢的文本编辑器中打开build.properties。调整构建设置，使dir.deploy指向您的Web服务器文档目录中的某个位置（现在忽略phpunit设置）

# point this to where you want to deploy the api tester
dir.deploy=C:\\xampp\\htdocs\\maileon-api-tester

# your phpunit executable
phpunit=phpunit.bat

现在在文件test/conf/config.include中输入您的Maileon API密钥。

接下来一步，您需要一个Apache Ant的有效安装。请确保将包含ant可执行文件的目录放在您的系统PATH中。

Ant安装完成后，在您解压缩API客户端的目录中运行它

C:\projects\maileon-php-client-0.10.3>ant
Buildfile: C:\projects\eagle_kunde\php-api-client\target\maileon-php-client-0.10.3\build.xml

deploy:
     [echo] [deploying project to C:\xampp\htdocs\maileon-api-tester]

BUILD SUCCESSFUL
Total time: 0 seconds

现在，您应该能够使用浏览器访问测试应用程序。根据上面的示例配置，只需将浏览器指向https:///maileon-api-tester/。

要验证您的安装是否正常，请在“Ping - 测试”部分中检查所有复选框，并在页面底部点击“运行测试”按钮。要执行其他测试，您将需要查看源代码，并调整输入数据以匹配您账户内的数据。

将API客户端安装到您的PHP应用程序中

将整个client子目录复制到您的Web服务器。然后，从使用客户端的代码中包含客户端的主要文件

// Include the Maileon API Client classloader 
require_once('./client/MaileonApiClient.php');

您可以将client子目录重命名，只要您也相应地更改require_once指令中的路径。您可能还需要安装根证书捆绑包，以启用通过HTTPS的安全传输。请参阅本文档的最后一节“使用HTTPS连接到API”中的说明，了解如何实现此目的。

运行PHPUnit测试

下载 PHPUnit 并将其可执行文件放在您的 PATH 中。如果您使用的是除 Windows 之外的操作系统，请调整 build.properties 文件中 phpunit 可执行文件的名字。确保您的 Maileon API 密钥在 test/conf/config.include 文件中输入正确。

现在，在您解压分发文件的目录中运行 ant test。

使用 HTTPS 连接到 API

由于您可能将通过 API 传输敏感的客户数据，因此您应该使用启用了 SSL 的 API 端点 https://api.maileon.com/1.0 而不是普通的 HTTP 版本。为此，您需要按照以下步骤安装 cURL 的根证书包：

从 http://curl.haxx.se/ca/cacert.pem 下载该包。
将包复制到 PHP 可以访问的目录。
在您的 php.ini 文件中添加以下条目（请记得将路径更改为您放置证书包的位置）

curl.cainfo="C:\xampp\php\cacert.pem"

现在，您应该能够连接到启用了 SSL 的 API 端点。

andreipop / maileon-api-client

维护者

详细信息