README

📢 我们非常高兴地宣布，我们的新App 开发平台现在对所有客户开放。我们强烈建议所有新应用都基于该平台构建，以充分利用其扩展的功能。

对于那些想要从我们的遗留自定义应用程序迁移的用户，我们已准备了全面的迁移指南。本指南将帮助您无缝过渡到新平台。

所有现有的遗留自定义应用程序将继续按原样运行。如果您想使用遗留框架安装遗留自定义应用程序，请点击这里。您仍然可以访问遗留自定义应用程序的文档这里。

请注意：虽然我们将继续支持这个遗留的PHP库，但未来的开发将集中在我们的新应用程序平台上。

动态应用程序客户端库

客户端库，用于帮助构建与Help Scout集成的自定义应用程序。更多信息：http://developer.helpscout.net/custom-apps/

当前版本

• 1.1.1

请参阅变更日志以获取详细信息。

安装

可以使用Composer安装Help Scout应用程序客户端。

Composer

在composer.json中指定以下内容

{
  "require": {
    "helpscout/apps": "1.1.*"
  }
}

示例用法（1）

use HelpScoutApp\DynamicApp;

include 'src/HelpScoutApp/DynamicApp.php';

$app = new DynamicApp('SECRET-KEY-HERE');
if ($app->isSignatureValid()) {
        $customer = $app->getCustomer();
        $user     = $app->getUser();
        $convo    = $app->getConversation();
        $mailbox  = $app->getMailbox();

        $html = array(
        	'<p>Convo</p>',
			'<ul>',
				'<li>Id: ' . $convo->getId() . '</li>',
                '<li>Number: ' . $convo->getNumber() . '</li>',
                '<li>Subject: ' . $convo->getSubject() . '</li>',
            '</ul>',
			'<p>Customer</p>',
			'<ul>',
				'<li>First: ' . $customer->getFirstName() . '</li>',
                '<li>Last: ' . $customer->getLastName() . '</li>',
                '<li>Email: ' . $customer->getEmail() . '</li>',
			'</ul>',
			'<p>User</p>',
			'<ul>',
                '<li>First: ' . $user->getFirstName() . '</li>',
                '<li>Last: ' . $user->getLastName() . '</li>',
                '<li>Id: ' . $user->getId() . '</li>',
			'</ul>',
			'<p>Mailbox</p>',
			'<ul>',
			    '<li>ID: ' . $mailbox->getId() . '</li>',
			    '<li>Email: ' . $mailbox->getEmail() . '</li>',
			'</ul>'
        );
        echo $app->getResponse($html);
} else {
        echo 'Invalid Request';
}

示例用法（2）

use HelpScoutApp\DynamicApp;

include 'src/HelpScoutApp/DynamicApp.php';

$app = new DynamicApp('SECRET-KEY-HERE');
if ($app->isSignatureValid()) {               
    echo $app->getResponse('<p>Hello World</p>');
} else {
    echo 'Invalid Request';
}