phil-lavin/trustico

dev-master 2013-09-26 07:54 UTC

This package is not auto-updated.

Last update: 2024-09-28 14:53:31 UTC


README

介绍

这个包并没有什么过于复杂的地方——它只是API的一个包装器。下面是示例用法代码。

\Trustico\API类提供了以下函数

  • test() - 检查API是否工作
  • hello($message) - API的Hello方法的包装器
  • order_status($order_id) - API的GetStatus方法的包装器
  • resend_approver_email($order_id) - API的ResendEmail方法(类型为Approver)的包装器
  • resend_fulfilment_email($order_id) - API的ResendEmail方法(类型为Fulfillment)的包装器
  • change_approver_email($order_id, $email) - API的ChangeApproverEmail方法的包装器
  • reissue($order_id, $email, $csr) - API的Reissue方法的包装器
  • get_user_agreement($product_name) - API的GetUserAgreement方法的包装器
  • get_approver_list($domain) - API的GetApproverList的包装器。返回一个\Trustico\Response\XML\ApproverList
  • process_order_type_1($data) - API的ProcessType1方法的包装器
  • process_order_type_2($data) - API的ProcessType2方法的包装器

安装

此代码需要PHP >= 5.5。

支持Composer安装和常规文件包含。对于Composer,将以下内容添加到您的composer.json中

"require": {
	"phil-lavin/trustico": "dev-master"
}

对于Composer,如果您使用Composer的自动加载器,库的类将自动加载。

如果您不使用Composer,只需将src/autoloader.php包含到您的应用程序中。这添加了一个SPL自动加载器,并且您可以按需调用类。

用法示例

<?php
$api = \Trustico\API::forge('user', 'pass');

$response = $api->hello("This is a test message");

if (!$response->is_success()) {
	die("Error...\n".$response->get_errors_string()."\n");
}

foreach ($response->get_data() as $k=>$v) {
        var_dump("$k => $v");
}

文档

由于它只是一个包装器,所以大部分都是自我文档化的。

查看\Trustico\API类,了解您可以调用的方法。它们是与https://resellers.trustico.com/geodirect/admin/api-overview.php上记录的API方法精确映射。您需要登录到经销商账户才能查看Trustico文档。

所有方法都应该不言自明。process_order_type_1()和process_order_type_2()接受一个由Trustico API文档中描述的字段名称键控的数组。

所有方法都将返回一个\Trustico\Response\XML\General,除了get_approver_list(),它返回一个\Trustico\Response\XML\ApproverList。ApproverList响应实现了一个get_emails()生成器方法(供您使用foreach遍历),它将稍微有点愚蠢的Trustico API响应解析成电子邮件地址列表。