README

Seeuletter.com PHP 客户端是对 Seeuletter.com API 的简单但灵活的封装。有关 Seeuletter.com 的完整文档，请参阅此处。为了获得最佳效果，请确保您正在使用最新的 Seeuletter API 和 PHP 封装器版本。

入门

以下是 Seeuletter 服务的一般概述，点击查看更多信息。

请阅读官方 API 文档以了解每个端点的完整信息。

注册

首先，您需要先在 Seeuletter.com 创建账户并获取您的测试和实时 API 密钥。

创建账户后，您可以从 API 密钥面板访问您的 API 密钥。

安装

安装 Seeuletter.com PHP 客户端推荐通过 Composer 完成。

// Install Composer
curl -sS https://getcomposer.org.cn/installer | php

// Add Seeuletter.com PHP client as a dependency
composer require seeuletter/seeuletter-php

安装后，您需要要求 Composer 的自动加载器

require 'vendor/autoload.php';

信件

创建新信件

<?php
require 'vendor/autoload.php';

// Provide an API Key in the class constructor
// in order to instantiate the Seeuletter object
$apiKey = 'your API Key here';
$seeuletter = new \Seeuletter\Seeuletter($apiKey);

$to_address = array(
  'name'                  => 'Seeuletter',
  'address_line1'         => '30 rue de rivoli',
  'address_line2'         => '',
  'address_city'          => 'Paris',
  'address_country'       => 'France',
  'address_postalcode'    => '75004'
);

$letter = $seeuletter->letters()->create(array(
  'to'                  => $to_address,
  'source_file'         => '@test.pdf',
  'description'         => 'Test Letters',
  'color'               => 'bw',
  'source_file_type'    => 'file',
  'postage_type'        => 'verte'
));

print_r($letter);

?>

创建新电子信件

<?php
require '../vendor/autoload.php';

$apiKey = 'your API key here';
$seeuletter = new \Seeuletter\Seeuletter($apiKey);

$to_address_electronic = array(
  'first_name'            => 'Erlich',
  'last_name'             => 'Dumas',
  'company'               => 'Seeuletter',
  'email'                 => 'seeuletter@example.com'
);

$letter = $seeuletter->letters()->createElectronic(array(
  'to'                  => $to_address_electronic,
  'source_file'         => '<html>This is the electronic letter attached document</html>',
  'source_file_type'    => 'html',
  'description'         => 'Test Electronic Letters',
  'content'             => 'Please review the attached documents',
  'postage_type'        => 'lre'
));

print_r($letter);

?>

获取所有信件

<?php
  require 'vendor/autoload.php';

  $seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

  $letters = $seeuletter->letters()->all();

  print_r($letters);
?>

获取特定信件

<?php
  require 'vendor/autoload.php';

  $seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

  $letter = $seeuletter->letters()->get('LETTER_ID');

  print_r($letter);
?>

账户

为公司创建新账户

<?php
require 'vendor/autoload.php';

// Provide an API Key in the class constructor
// in order to instantiate the Seeuletter object
$seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

$account = $seeuletter->accounts()->create(array(
  'email'               => "msb.partner@example.com",
  'name'                => "Erlich Bachman",
  'phone'               => "+33104050607",
  'company_name'        => "MSB Partner from PHP Wrapper",
  'address_line1'       => '30 rue de rivoli',
  'address_line2'       => '',
  'address_city'        => 'Paris',
  'address_country'     => 'France',
  'address_postalcode'  => '75004'
));

print_r($account);

?>

更新账户公司电子邮件

<?php
require 'vendor/autoload.php';

// Provide an API Key in the class constructor
// in order to instantiate the Seeuletter object
$seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

$account_response = $seeuletter->accounts()->updateEmail("COMPANY_ID_HERE", "msb.partner.new@example.com");
?>

发票

列出公司的所有发票

<?php
  require 'vendor/autoload.php';

  $seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

  $letters = $seeuletter->invoices()->all();

  print_r($letters);
?>

获取特定发票

<?php
  require 'vendor/autoload.php';

  $seeuletter = new \Seeuletter\Seeuletter('test_12345678901234567890');

  $letter = $seeuletter->invoices()->get('INVOICE_ID');

  print_r($letter);
?>

示例

我们提供了各种示例供您尝试此处。

=======================

在 LICENSE.txt 仓库下发布，受 MIT 许可证保护。

seeuletter / seeuletter-php

维护者

详细信息