authorizenet/authorizenet

Authorize.Net的官方PHP SDK

2.0.4 2024-09-18 06:23 UTC

README

Authorize.net PHP CI Packagist Stable Version

需求

  • PHP 5.6到8.x.x
  • 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功能的详细信息或澄清,请创建一个包含您问题的issue。您还可以搜索Authorize.Net开发者社区中与您问题相关的讨论。
  • 在创建pull请求之前,请阅读贡献指南

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.3"
  }
}

通过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);

...

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

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

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 字段对应于对象中属性的名称,或应完全隐藏的 xml 标签(如果未指定替代内容,则显示 XXXX)或应被隐藏(例如,显示信用卡号的最后4位)。
    • pattern[注意]replacement[注意] 可以留为 "",如果默认值(在 Log.php 中定义)将被使用。 pattern 提供了用于识别的正则表达式,而 replacement 定义了可见的部分。
    • disableMask 可以设置为 true 以允许日志完全显示对象中的属性,或在 XML 字符串中的标签。
  • sensitiveStringRegexes[注意] 包含信用卡正则表达式的列表。因此,如果信用卡号尚未被隐藏,则将完全隐藏。
  • 在定义正则表达式时要小心非 ASCII 字符(参考 手册),例如,使用 "pattern": "(\\p{N}+)(\\p{N}{4})" 而不是 "pattern": "(\\d+)(\\d{4})"。还要注意使用了 \\ 转义序列。

注意: 对于任何正则表达式,不应定义起始或结束的 '/' 或其他分隔符。在代码中添加了 '/' 分隔符和 Unicode 标志。

交易哈希升级

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

许可证

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