README

关于

此PHP客户端旨在与NetSapiens V1 API交互。它提供了一种方便的方式来验证并调用NetSapiens服务的API。

安装

要安装NetSapiens PHP客户端，请使用Composer

composer require spectrumvoip/netsapiensclient

基本用法

初始化

首先，在您的PHP脚本中包含Composer自动加载器

require 'vendor/autoload.php';

然后，创建一个NetSapiensClient实例

$nsclient = new \spectrumvoip\NetSapiensClient\NetSapiensClient('your-hostname.com');

身份验证

要使用NetSapiens API进行身份验证

$nsclient->login($clientId, $clientSecret, $username, $password);

将$clientId、$clientSecret、$username和$password替换为您实际的凭据。

进行API调用

GET请求示例

以下是如何计数域名的示例

$params = [
    'format' => 'json',
    'object' => 'domain',
    'action' => 'count',
    'domain' => '*'
];

try {
    $response = $nsclient->ns_api_get($params);
    echo "Number of domains: " . $response['total'];
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}

POST请求示例

要发送POST请求

$params = [
    'format' => 'json',
    'object' => 'user',
    'action' => 'create',
    // Add other necessary parameters
];

try {
    $response = $nsclient->ns_api_post($params);
    echo "User created successfully";
} catch (Exception $e) {
    echo "Error: " . $e->getMessage();
}

高级功能

令牌刷新

客户端会自动在令牌即将到期时刷新访问令牌。在大多数情况下，您无需手动刷新令牌。

伪装

要伪装成另一个用户

$masqueradeResponse = $nsclient->masquerade_token($uid, $accessToken);

将$uid替换为您想要伪装的用户ID，将$accessToken替换为有效的访问令牌。

错误处理

客户端在API错误和连接问题时抛出异常。始终将API调用包裹在try-catch块中，以便优雅地处理潜在的错误。

API参考

有关可用API方法和其参数的完整列表，请参阅NetSapiens API文档。

贡献

如果您发现任何问题或对改进有建议，请在该GitHub存储库中打开问题或提交拉取请求。

许可

本项目采用MIT许可。

光谱VoIP / netsapiensclient

维护者

详情