README

NetSuite 的 PHP API 客户端包，源自 NetSuite PHP 工具包，并针对现代 PHP 应用程序开发进行了优化。所有位于 NetSuite\Classes 命名空间中的类都是 NetSuite 提供的代码，带有允许重新分发的许可证。此库提供的自定义工作将这些近 2,000 个类分别放入自己的文件中，并允许使用 composer 安装类并使用标准自动加载支持访问。它允许从环境变量中读取配置，添加对日志请求和响应的支持，并提供简化的客户端封装类（NetSuiteService）。

安装
快速入门
- 与 Laravel 集成
特定账户的数据中心 URL
示例
日志记录
生成类
路线图
支持
贡献
许可证

安装

使用 composer 安装

composer require ryanwinchester/netsuite-php

快速入门

实例化 NetSuiteService 类

以下示例将假设您已经使用基于令牌的认证实例化了一个客户端对象。NetSuite 在 2020 年停止支持使用用户凭据进行认证的方法。

// Token-based Authentication
require 'vendor/autoload.php';

use NetSuite\NetSuiteService;

$config = [
    // required -------------------------------------
    "endpoint"       => "2021_1",
    "host"           => "https://webservices.netsuite.com",
    "account"        => "MYACCT1",
    "consumerKey"    => "0123456789ABCDEF",
    "consumerSecret" => "0123456789ABCDEF",
    "token"          => "0123456789ABCDEF",
    "tokenSecret"    => "0123456789ABCDEF",
    // optional -------------------------------------
    "signatureAlgorithm" => 'sha256', // Defaults to 'sha256'
    "logging"  => true,
    "log_path" => "/var/www/myapp/logs/netsuite",
    "log_format"     => "netsuite-php-%date-%operation",
    "log_dateformat" => "Ymd.His.u",
];
$service = new NetSuiteService($config);

您还可以将配置放置在环境变量中。这在托管环境中很有用，在这些环境中，部署配置文件可能不受欢迎或不切实际。您可以在包含示例值的包含的 .env.example 文件中找到有效的键。

以前，使用 ENV 数据实例化 NetSuiteClient 需要使用静态方法 createFromEnv。此方法现在已被标记为 已弃用，如果您正在使用它，请更改您的代码以使用标准构造函数，该构造函数将为您提取 $_ENV 超全局中的配置。

// Allowing the client to infer configuration from $_ENV
require 'vendor/autoload.php';

use NetSuite\NetSuiteService;

$service = new NetSuiteService();

Laravel 集成

如果您正在 Laravel 应用程序中实现 NetSuite 网络服务，您可能想看看 netsuite-laravel 包，以简化实例化和通过服务容器将客户端提供给您的应用程序。在这种情况下，您只需在您的应用程序中包含 netsuitephp/netsuite-laravel 包，只要客户端配置存在于应用程序的环境变量中，您就会在容器中获得客户端实例。

特定账户的数据中心 URL

从 2021_1 开始，此库提供了在每个请求上利用 NetSuite 的新特定账户数据中心 URL 检测的支持。在实际应用中，此查找确实存在可衡量的开销成本。因此，我建议仅在您的 NetSuite 集成方式使得连接较少，批量处理集成时使用此功能。如果您的集成方式是向 NetSuite 发送许多频繁、简短请求，那么您可能更喜欢明确提供数据中心 URL 并从每个会话中删除查找。

// Recommended: Use your own defined data center URL (or sandbox, for instance):
$config['host'] = 'https://123456789.suitetalk.api.netsuite.com';

// To allow the service to get the correct URL for your account on the fly,
// use the legacy webservices url.
$config['host'] = 'https://webservices.netsuite.com';

示例

请参阅 EXAMPLES.md

日志记录

启用日志记录的最常见方法是在配置级别进行，请参阅快速入门示例。

您还可以在运行时使用方法设置日志记录的开启或关闭。请注意，如果您在配置或运行时没有指定日志目录，则不会创建任何日志。必须有一个有效的目标位置。

// Set a logging path
$service->setLogPath('/path/to/logs');

// Turn logging on
$service->logRequests(true);  // Turn logging on.

// Turn logging off
$service->logRequests(false); // Turn logging off.

如果您需要更多的日志记录灵活性，您可以提供自己的PSR-3兼容的日志记录器（自2023.1.0版本起）。

生成类

此存储库始终包含从与特定发布版本相对应的NetSuite PHP Toolkit生成的类。例如，发布v2021.1.0是针对NetSuite的2021_1网络服务工具包构建的第一个版本。如果您出于任何原因想自己生成类文件，该包中包含相应的代码，按照以下步骤进行

下载NetSuite PHP Toolkit
将内容解压到./original/文件夹
运行./utilities/separate_classes.php或composer generate

路线图

PHP版本支持

查看：https://php.ac.cn/supported-versions.php

由于从2018年底起官方不再支持PHP5，以及PHP7将于2021年底转向仅提供安全支持，本包支持的PHP版本将逐步向前推移。

目前，对于netsuitephp/netsuite-php，请期待以下要求

从2021_1构建起，要求"php": ">=7.1"
从2023_1构建起，要求"php": ">=8"

这仅适用于新发布的包，因此如果您无法或不愿更新PHP，您仍然可以使用您PHP版本的最后一个支持版本。

支持

如果您需要实施方面的帮助，请查看示例文件中的资源部分，其中包含一些有用的链接。

如果您认为您的问题是该包提供的自定义工作（而不是包中包含的NetSuite自己的类）的特定错误，则可以在GitHub上提交问题。按照问题模板，请包括对问题的清晰描述、复现方式以及使用此包的日志记录功能的相关请求/响应日志。

贡献

欢迎以pull request的形式提交贡献。请明确说明变更的原因，并尽量使变更尽可能小，这将提高我们审阅它们的速度，并增加被包含到主分支的可能性。

请确保尊重当前在composer.json中要求的php版本。
请避免引入新的依赖项（没有框架钩子等）
请尽量确保所有新增内容符合PSR-12

许可证

所有额外的工作均根据包含的LICENSE文件，在Apollo 2.0开源软件许可下进行。

happones / netsuite-php

维护者

详细信息