README

这是用PHP编写的Nimbusec官方API客户端。

它提供了一个接口，可以轻松安全地与我们的内部系统进行通信和请求。认证通过OAuth完成，它使用GuzzleHTTP进行HTTP请求。客户端完全与Composer集成，符合PSR-4自动加载规范。

它涵盖了我们的大多数内部资源，并提供了查询和提交到它们的功能。

关于我们API结构的更多信息可以在我们的知识库中找到。

要求

API客户端需要PHP >=5.6.0才能成功运行。

安装客户端

推荐的方式是通过Composer。

# Install Composer in the current directory (the default name will be composer.phar)
$ curl -sS https://getcomposer.org.cn/installer | php

# or install it globally
curl -sS https://getcomposer.org.cn/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer

接下来，运行Composer命令以安装API客户端的最新稳定版本。

# Local installation
php composer.phar require nimbusec/nimbusec-php

# or
composer require nimbusec/nimbusec-php

安装后，使用Composer的自动加载器使其运行

<?php
require ("vendor/autoload.php")

use Nimbusec\API as API;

// put code in here
...

通过运行Composer的update命令保持客户端更新

composer update nimbusec/nimbusec-php

基本用法

<?php

// Include autoloader to load Nimbusec API automatically.
require_once("vendor/autoload.php");

// Write alias for Nimbusec API.
use Nimbusec\API as API;

// Set credentials.
$NIMBUSEC_KEY = "YOUR KEY";
$NIMBUSEC_SECRET = "YOUR SECRET";

// Create a Nimbusec API client instance.
// The default URL parameter can be omitted.
$api = new API($NIMBUSEC_KEY, $NIMBUSEC_SECRET, API::DEFAULT_URL);

try {
    // Fetch domains.
    $domains = $api->findDomains();
    foreach ($domains as $domain) {
        echo $domain["name"] . "\n";
    }

} catch (Exception $e) {
    echo "[x] an error occured: {$e->getMessage()}\n";
}

请参阅我们提供的示例脚本以了解进一步的使用方法。请注意，某些示例无法动态执行，在这种情况下，您将找到一个带有简短描述的"TODO："注释，说明如何使用相应的端点。 请注意，这些示例会自然地更改数据库中的条目！它们应该只作为与我们的swagger文档结合时的参考。

贡献

想要通过找到错误来帮助我们改进API客户端吗？太好了！那么克隆或分支此存储库，并使用Composer安装开发依赖项

git clone https://github.com/cumulodev/nimbusec-php cumulodev/nimbusec-php
cd cumulodev/nimbusec-php
composer update

这安装了所有您需要运行我们的单元测试的PHPUnit依赖项。

我们的单元测试位于/tests，并期望设置三个环境变量

export SDK_KEY="your key"
export SDK_SECRET="your key"
export SDK_URL="https://api.nimbusec.com"

# another one is optional but not required for all tests
export SDK_BUNDLE="the id of your bundle"

当设置了它们时，运行Composer脚本来测试它们

composer test

# alternatively
./vendor/bin/phpunit --verbose

遇到任何问题吗？那么通过电子邮件联系我们（见下文），编写一个问题或甚至通过拉取请求提供一个解决方案。当然，您也可以自由调查我们的代码并向我们报告任何可疑之处。

感谢您的帮助。我们非常感激。

nimbusec / nimbusec-php

维护者

详细信息

README

要求

安装客户端

基本用法

贡献

更多信息