README

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

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

安装

使用 composer 安装

composer require ryanwinchester/netsuite-php

快速入门

实例化 NetSuiteService 类

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

// 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.

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

生成类

此存储库始终包含与特定版本标记的Web服务版本相对应的NetSuite PHP Toolkit生成的类。例如，版本v2021.1.0是第一个针对NetSuite的2021_1 Web服务工具包构建的版本。如果您想自己生成类文件，出于任何原因，包中包含使用以下步骤实现的代码

下载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 requests的形式提供贡献。请包括对更改原因的清晰解释，并尽量保持更改尽可能小，这将增加我们审查它们的速度以及它们被包含到主分支中的可能性。

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

许可证

所有额外工作均根据包含的LICENSE文件，按照Apache 2.0开源软件许可证授权。

fungku / netsuite-php

维护者

详情