README

这是Kirim.Email营销API的非官方PHP客户端库。[Kirim.Email营销API的官方文档在这里](https://documenter.getpostman.com/view/23706886/2s83zduQge)

安装

选项1：通过Packagist安装

composer require --dev dwijonarko/php-kirimemail:dev-main

或者将以下内容添加到composer.json

{
  "require": {
    "dwijonarko/php-kirimemail": "dev-main"
  }
}

选项2：手动安装

克隆仓库

git clone git@github.com:dwijonarko/phpkirimemail.git

在客户端库项目根目录下，安装所有依赖项

composer install

在您的实现中手动包含vendor/autoload.php

快速入门

<?php
require_once('vendor/autoload.php');
use Dwijonarko\PHPKirimemail\Lists;
$config= [
    'username'=>'YOURUSERNAME',
    'api_token'=>'YOUR KIRIM EMAIL API TOKEN'
];

$lists = new Lists($config);
$result = $lists->getAll();
var_dump($result);

函数

列表

1. 获取所有列表

$lists = new Lists($config);
$result = $lists->getAll();

1. 按ID获取列表

$lists = new Lists($config);
$result = $lists->getById($listID);

1. 创建列表

$lists = new Lists($config);
$list_name = 'List Name';
$result = $lists->create($list_name);

1. 更新列表

$lists = new Lists($config);
$list_name = "Update Name";
$result = $lists->update($list_id,$list_name);

1. 删除列表

$lists = new Lists($config);
$result = $lists->delete($list_id);

订阅者

1. 获取所有订阅者

$subscribers = new Subscribers($config);
$result = $subscribers->getAll();

1. 按ID获取订阅者

$subscribers = new Subscribers($config);
$result = $subscribers->getById($id);

1. 按邮箱获取订阅者

$subscribers = new Subscribers($config);
$result = $subscribers->getByEmail($subscriber_email);

1. 创建订阅者

$subscribers = new Subscribers($config);
$subscriber_params = [
	'email'  =>  'email@example.com',
	'full_name'  =>  'Full Name',
	'lists'  => $list_id,
	'status'  =>  'subscribed',
	'tags'  =>  'api,php',
	'fields'  => [
		'phone'  =>  '081234567890',
		'address'  =>  'Jl. Jalan'
	]]
$result = $subscribers->create($subscriber_params);

1. 按ID更新订阅者

$subscribers = new Subscribers($config);
$subscriber_params = [
	'email'  =>  'email@example.com',
	'full_name'  =>  'Full Name',
	'lists'  => $list_id,
	'status'  =>  'subscribed',
	'tags'  =>  'api,php',
	'fields'  => [
		'phone'  =>  '081234567890',
		'address'  =>  'Jl. Jalan'
	]]
$result = $subscribers->update($subscriber_id,$subscriber_params);

1. 按邮箱更新订阅者

$subscribers = new Subscribers($config);
$subscriber_params = [
	'email'  =>  'email@example.com',
	'full_name'  =>  'Full Name',
	'lists'  => $list_id,
	'status'  =>  'subscribed',
	'tags'  =>  'api,php',
	'fields'  => [
		'phone'  =>  '081234567890',
		'address'  =>  'Jl. Jalan'
	]]
$result = $subscribers->updateByEmail($subscriber_email,$subscriber_params);

1. 删除订阅者

$subscribers = new Subscribers($config);
$result = $subscribers->getAll();

订阅者字段

1. 获取所有订阅者字段

$subscriber_field = new SubscriberFields($config);
$result = $subscriber_field->getAll();

1. 按ID获取订阅者字段

$subscriber_field = new SubscriberFields($config);
$result = $subscriber_field->getById($subsciber_field_id);

1. 创建订阅者字段

$subscriber_field = new SubscriberFields($config);
$subscriber_field_param = [
	'name' => 'Address',
    'type' => 'textarea',
];
$result = $subscriber_field->create($subscriber_field_param);

1. 更新订阅者字段

$subscriber_field = new SubscriberFields($config);
$subscriber_field_param = [
	'name' => 'Address',
    'type' => 'textarea',
];
$result = $subscriber_field->updpate($id,$subscriber_field_param);

1. 删除订阅者字段

$subscriber_field = new SubscriberFields($config);
$result = $subscriber_field->delete($subscriber_field_id);

表单

1. 获取所有表单

$form = new Forms($config);
$result = $form->getAll();

1. 按ID获取表单

$form = new Forms($config);
$result = $form->getById($form_id);

1. 按URL获取表单

$form = new Forms($config);
$parse_url = parse_url($url, PHP_URL_PATH);
if (!empty($parse_url)) {
	$path = explode('/', $parse_url);
    $form_url = end($path);
}else{
	$form_url = $url;
}
$result = $form->getByUrl($form_url);

落地页

1. 获取所有落地页

$landing = new LandingPages($config);
$result = $landing->getAll();

1. 按ID获取落地页

$landing = new LandingPages($config);
$result = $landing->getById($form_id);

1. 按URL获取落地页

$landing = new LandingPages($config);
$parse_url = parse_url($url, PHP_URL_PATH);
if (!empty($parse_url)) {
	$path = explode('/', $parse_url);
    $form_url = end($path);
}else{
	$form_url = $url;
}
$result = $landing->getByUrl($form_url);

广播

1. 获取所有广播

$broadcast = new Broadcasts($config);
$result = $broadcast->getAll();

1. 按GUID获取广播

$broadcast = new Broadcasts($config);
$result = $broadcast->getByGuid($broadcast_guid);

1. 创建广播 注意：消息包含主题和内容。您最多可以发送3条消息。

$broadcast = new Broadcasts($config);
$param[
	'title'=>'Title',
	'sender'=>'Email Sender',
	'messages[0][subject]'=>'Email Subject',
	'messages[0]['content]'=>'Email content, ', //disallow css and js, read official docs for detail
	'send_at'=>'2018-12-30 00:00:00',
	'list'=>1
	];
$result = $broadcast->create($params);

1. 编辑广播 注意：如果当前广播类型为SPLIT，则需要添加所有消息。如果您只添加一条消息，则类型将变为SINGLE。发送的消息必须始终等于当前广播消息数量。

$broadcast = new Broadcasts($config);
$param[
	'title'=>'Title',
	'sender'=>'Email Sender',
	'messages[0][subject]'=>'Email Subject',
	'messages[0]['content]'=>'Email content, ', //disallow css and js, read official docs for detail
	];
$result = $broadcast->update($broadcast_guid,$params);

1. 删除广播

$broadcast = new Broadcasts($config);
$result = $broadcast->update($broadcast_guid);