scott-cashortrade/authorize-net-sdk

Authorize.Net的官方PHP SDK

1.0.1 2023-05-01 20:04 UTC

This package is not auto-updated.

Last update: 2024-10-02 01:13:05 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功能的信息或澄清,请创建一个包含您问题的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。(注意:我们绝不推荐您覆盖新的安全http默认设置)。请按照以下示例更新您的composer.json文件,然后运行composer update以更新此特定版本。

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

通过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配置为使用沙箱环境。要切换到生产环境,请替换execute方法中的环境常量。例如

// 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 位)。
    • patternreplacement 可以留为 "",如果使用默认值(如 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 文件。