swoogo/authorizenet

Authorize.Net 官方 PHP SDK

2.0.0.1 2020-01-14 16:03 UTC

README

Travis CI Status Scrutinizer Code Quality Packagist Stable Version

要求

  • PHP 5.6+
  • cURL PHP 扩展
  • JSON PHP 扩展
  • 一个 Authorize.Net 账户(见下文的 注册与配置 部分)
  • 支持 TLS 1.2 的 libcurl 和 OpenSSL 版本(或其等效版本)

从旧版本迁移

自 2018 年 8 月以来,Authorize.Net API 已重组,以更加注重商户。已弃用 Authorize.Net AIM、ARB、CIM、交易报告和 SIM 类,转而使用 net\authorize\api。要查看对应于已弃用功能的完整新功能映射列表,请参阅 MIGRATING.md

贡献

  • 如果您需要有关 Authorize.Net 功能的信息或澄清,请创建一个问题与您的问题一起提出。您还可以搜索 Authorize.Net 开发者社区中与您问题相关的讨论。
  • 在创建拉取请求之前,请阅读 贡献者指南

TLS 1.2

Authorize.Net API 仅支持使用 TLS 1.2 安全协议进行连接。请确保升级所有必要的组件以支持 TLS 1.2。保持这些组件更新,以减轻新的安全漏洞风险。

要测试您的当前安装是否能够使用 TLS 1.2 与我们的服务器进行通信,请运行以下 PHP 代码并检查输出中的 TLS 版本

<?php
    $ch = curl_init('https://apitest.authorize.net/xml/v1/request.api');
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_VERBOSE, true);
    $data = curl_exec($ch);
    curl_close($ch);

如果 curl 无法连接到我们的 URL(如前一个示例中所示),则您的系统可能无法使用 TLS 1.2 进行连接,或者未安装受支持的加密算法。要验证您的连接是否支持以下 TLS 版本,请运行以下 PHP 代码

<?php 
$ch = curl_init('https://www.howsmyssl.com/a/check');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$data = curl_exec($ch);
curl_close($ch);

$json = json_decode($data);
echo "Connection uses " . $json->tls_version ."\n";

安装

Composer

我们建议使用 Composer(注意:我们从不建议您覆盖新的 secure-http 默认设置) 根据以下示例更新您的 composer.json 文件,然后运行 composer update 以针对此特定版本。

{
  "require": {
  "php": ">=5.6",
  "authorizenet/authorizenet": "2.0.0"
  }
}

通过 Composer 安装后,不要忘记在您的脚本或引导文件中引入其自动加载器

require 'vendor/autoload.php';

自定义 SPL 自动加载器

或者,我们提供了一个自定义的 SPL 自动加载器,您可以在 PHP 文件中引用它

require 'path/to/anet_php_sdk/autoload.php';

此自动加载器仍然需要 vendor 目录及其所有依赖项存在。然而,这可能是 composer 无法在特定系统上运行的情况下的解决方案。您可以在本地或另一台系统上运行 composer 来构建目录,然后将 vendor 目录复制到所需的系统。

注册与配置

使用此 SDK 和 Authorize.Net API 需要在 Authorize.Net 系统上拥有账户。您可以在设置部分找到这些详细信息。如果您目前没有生产环境中的 Authorize.Net 账户,请注册沙盒账户

身份验证

要使用Authorize.Net API进行身份验证,请使用您的账户API登录ID和交易密钥。如果您没有这些凭证,请从商家界面获取。对于生产账户,商家界面位于(https://account.authorize.net/),而对于沙盒账户,位于(https://sandbox.authorize.net)。

获取凭证后,将其加载到您的代码中相应的变量中。以下示例代码显示了如何将凭证作为API请求的一部分进行设置。

设置API请求的API凭证

...

use net\authorize\api\contract\v1 as AnetAPI;

...

$merchantAuthentication = new AnetAPI\MerchantAuthenticationType();
$merchantAuthentication->setName("YOURLOGIN");
$merchantAuthentication->setTransactionKey("YOURKEY");

...

$request = new AnetAPI\CreateTransactionRequest();
$request->setMerchantAuthentication($merchantAuthentication);

...

您绝对不应该将登录ID和交易密钥直接包含在您的网站上公开访问部分的PHP文件中。更好的做法是在常量文件中定义这些,然后在代码中的适当位置引用这些常量。

在沙盒环境和生产环境之间切换

Authorize.Net维护一个完整的沙盒环境,用于测试和开发目的。沙盒环境是我们生产环境的精确副本,具有模拟的交易授权和结算。默认情况下,此SDK配置为使用沙盒环境。要切换到生产环境,请在执行方法中替换环境常量。例如

// For PRODUCTION use
$response = $controller->executeWithApiResponse(\net\authorize\api\constants\ANetEnvironment::PRODUCTION);

每个环境的API凭证都不同,因此当切换环境时,请确保切换到适当的凭证。

SDK使用示例和示例代码

要开始使用此SDK,强烈建议下载我们的示例代码库

在该存储库中,我们为API的所有常见用法提供了全面的示例代码

此外,您可以在我们的API参考指南中找到有关我们的API结构详情和示例

API参考指南提供了特定请求所需信息以及该信息的格式化方式的示例。使用这些示例,您可以轻松确定使用此SDK将信息包含在请求中所需的方法。

构建和测试SDK

AuthorizeNet SDK的集成测试位于tests目录中。这些测试主要针对SDK开发。但是,您也可以浏览它们以找到更多各种API的使用示例。

  • 运行composer update --dev以加载PHPUnit测试库。
  • phpunit.xml.dist文件复制到phpunit.xml,并在常量字段中输入您的商家凭证。
  • 运行vendor/bin/phpunit以运行测试套件。

您可能希望禁用沙盒账户上的电子邮件。

测试指南

为了在测试自己的代码时获得更多帮助,Authorize.Net维护了一个全面的测试指南,其中包含要使用的测试信用卡号和用于从沙盒环境生成特定响应的特殊触发器。

日志记录

SDK生成包含对敏感数据(如信用卡、到期日期)进行屏蔽的日志。提供的日志级别为debuginfowarnerror。添加use \net\authorize\util\LogFactory;。使用$logger = LogFactory::getLog(get_class($this));初始化记录器。默认日志文件phplog在当前文件夹中生成。后续日志附加到同一文件,除非执行文件夹更改,并且生成新的日志文件。

使用示例

  • 记录字符串消息$logger->debug("发送'XML'请求类型");
  • 记录xml字符串$logger->debug($xmlRequest);
  • 使用格式化记录$logger->debugFormat("整数:%d,浮点数:%f,XML请求:%s\n", array(100, 1.29f, $xmlRequest));

自定义敏感标记

当首次执行调用日志的代码时,将生成一个本地副本 AuthorizedNetSensitiveTagsConfig.json。开发者可以稍后编辑本地文件,重新配置哪些属性应该被隐藏,哪些应该可见。(请不要编辑SDK中的JSON文件)。

  • 对于 sensitiveTags 数组中的每个元素:
    • tagName 字段对应于对象中的属性名称,或应该完全隐藏(如果没有指定替代项,将显示 XXXX)或被遮盖(例如,显示信用卡号的最后4位)的xml标签。
    • patternreplacement 可以留空 "",如果默认使用(如 Log.php 中定义的)。pattern 提供了用于识别的regex,而 replacement 定义了可见的部分。
    • disableMask 可以设置为 true 以允许日志完全显示对象中的属性或XML字符串中的标签。
  • sensitiveStringRegexes 包含信用卡regex列表。因此,如果信用卡号尚未被遮盖,它将被完全遮盖。
  • 在定义regex时要注意非ASCII字符(参考 手册),例如,使用 "pattern": "(\\p{N}+)(\\p{N}{4})" 而不是 "pattern": "(\\d+)(\\d{4})"。另外,请注意使用 \\ 转义序列。

注意 对于任何regex,不应定义起始或结束的 '/' 或其他分隔符。代码中会添加 '/' 分隔符和unicode标志。

交易哈希升级

Authorize.Net 正在淘汰基于MD5的 transHash 元素,转而使用基于SHA-512的 transHashSHA2。控制MD5哈希选项的商户接口设置不再可用,并且 transHash 元素将在以后的一个日期停止返回值。有关如何使用 transHashSHA2 的信息,请参阅[交易哈希升级指南] (https://developer.authorize.net/support/hash_upgrade/)。

许可证

此存储库在专有许可证下分发。请参阅提供的 LICENSE.txt 文件。