ncrypt-site / php-sdk
此包已被弃用,不再维护。未建议替代包。
ncrypt.site 的 PHP SDK
v1.2.0
2020-10-12 11:37 UTC
Requires
- php: >=7.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- ext-openssl: *
- guzzlehttp/guzzle: ^6.0
Requires (Dev)
- friendsofphp/php-cs-fixer: 2.15.*
- phpunit/phpunit: ^9
- roave/security-advisories: dev-master
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-05-12 19:44:39 UTC
README
nCrypt API 文档
此 SDK 允许您在应用程序中使用 nCrypt。这意味着您可以在应用程序中轻松创建一个安全的笔记。
Swagger-CodeGen 最初生成此 SDK 的一部分,然后对其进行修改以满足需求,这些代码将在下一两个版本中删除,因为我的想法是尽快发布第一个版本。
要求
PHP 7.1 及以上
安装 & 使用
Composer
您可以通过 composer 轻松安装 nCrypt SDK
composer require ncrypt-site/php-sdk
入门
安装 SDK 后,您可以使用以下示例
use NCrypt\Client\Api\NCryptAPI; use NCrypt\Client\Library\RequestBuilder\RequestBuilder; include './vendor/autoload.php'; $api = new NCryptAPI( new GuzzleHttp\Client() ); $requestBuilder = new RequestBuilder(); $request = $requestBuilder->prepareSecureNoteRequest('Your Very Secure Note', 1, false); try { $result = $api->notePost($request->getNoteRequest()); echo 'Note URL is: ' . $result->getData()->getUrl() . PHP_EOL; echo 'You can unseal the note with this key: ' . $request->getSecureNote()->getKey() . PHP_EOL; } catch (Exception $e) { echo $e->getMessage(); }
prepareSecureNoteRequest
此方法接受三个参数,就像网站内的字段一样。
# | 参数 | 类型 | 示例 |
---|---|---|---|
1 | $note | 字符串 | 是否曾经有过不确定自己是清醒还是做梦的感觉? |
2 | $selfDestruct | 整数 | 1 |
3 | $destructAfterOpening | 布尔值 | true |
$selfDestruct 可接受的值
以下数字是 $selfDestruct 参数的可接受值,请注意,这些值基于小时,将指示我们将笔记存储在我们的服务器上的时间。
[ 1, 3, 6, 12, 24, 48, 72, 168 ]
问题
目前没有已知问题,但请随时在 Github 上创建问题,以便我可以尽快修复。