joshyan / stannp-php
Stannp邮件API的PHP SDK
v0.2.0
2022-03-07 15:53 UTC
Requires
- php: >=5.3.0
Requires (Dev)
- squizlabs/php_codesniffer: 3.x-dev
README
我们的API提供对Stannp批量邮件账户的编程访问。配置活动、提供数据以及触发邮件发送等操作都可以通过简单且安全的HTTP请求实现。此SDK旨在为您提供一个简单地将我们的API集成到应用程序中的方法。
有关参数和API选项的更多信息,可以在Stannp API文档中找到 此处。
配置
最好通过composer安装
composer update stannp\stannpphp
必须引入自动加载器
require_once 'YOUR/PROJECT/ROOT/vendor/autoload.php';
API密钥必须在对象实例化时作为参数传递或在您的应用程序中设置为常量。没有有效的API密钥将无法工作。
示例
define("STANNP_API_KEY", "API_KEY_HERE"); or $user = new User("API_KEY_HERE");
您可以在Stannp设置页面底部找到您的API密钥。
使用方法
与API一样,SDK被分解为单独的组件。类和方法命名方案与API文档相匹配;这些类的完整列表包括
use Stannp\API\Campaigns; use Stannp\API\Groups; use Stannp\API\Letters; use Stannp\API\Postcard; use Stannp\API\Recipients; use Stannp\API\Reporting; use Stannp\API\User;
使用示例
use Stannp\API\Postcard; $user = new User(); $user->getMe();
use Stannp\API\Postcard $postcard = new Postcard(); $postcard->create( "A6", "https://www.stannp.com/assets/samples/a6-postcard-front.jpg", "Hello World", "Signature goes here", "Mr", "John", "Smith", "123 Fakestreet", "Address ln 2", "Cityshire", "AB12 3CD", true, "GB" );
输出
所有输出都是JSON格式,要将其转换为PHP对象,请使用 json_decode()