PHPackages                             ncrypt-site/php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ncrypt-site/php-sdk

AbandonedArchivedLibrary[API Development](/categories/api)

ncrypt-site/php-sdk
===================

PHP SDK for ncrypt.site

v1.2.0(5y ago)461AGPL-3.0-or-laterPHPPHP >=7.1

Since Aug 20Pushed 5y agoCompare

[ Source](https://github.com/Ncrypt-Site/php-sdk)[ Packagist](https://packagist.org/packages/ncrypt-site/php-sdk)[ Docs](https://ncrypt.site)[ RSS](/packages/ncrypt-site-php-sdk/feed)WikiDiscussions master Synced 1w ago

READMEChangelog (3)Dependencies (5)Versions (4)Used By (0)

nCrypt PHP SDK
==============

[](#ncrypt-php-sdk)

nCrypt API documentation

This SDK allows you to use [nCrypt](https://ncrypt.site) in your application. It means you can easily create a secure note inside your application.

Swagger-CodeGen initially generated part of this SDK, and then it was modified to fit the needs, those codes will be removed in the next couple of releases as it was my idea to release the first version as soon as possible.

- SDK version: [![version](https://camo.githubusercontent.com/62466f734e0cfeefbb050f1aab7c8434cf38325742c0c3acd1fca025c71d92c9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f4e63727970742d536974652f7068702d73646b)](https://camo.githubusercontent.com/62466f734e0cfeefbb050f1aab7c8434cf38325742c0c3acd1fca025c71d92c9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f762f72656c656173652f4e63727970742d536974652f7068702d73646b)

Requirements
------------

[](#requirements)

PHP 7.1 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

You can easily install nCrypt SDK via composer:

```
composer require ncrypt-site/php-sdk
```

Getting Started
---------------

[](#getting-started)

After installing the SDK, you can use it as the sample below:

```
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

[](#preparesecurenoterequest)

This method accepts three arguments, just like the fields inside the website.

\#ArgumentTypeExample1$notestringEver have that feeling where you’re not sure if you’re awake or dreaming?2$selfDestructint13$destructAfterOpeningbooleantrue##### $selfDestruct acceptable values:

[](#selfdestruct-acceptable-values)

The following numbers are acceptable values for `$selfDestruct` argument, note that the values are based on hour and will indicate how long we will store the notes on our servers.

```
[
    1,
    3,
    6,
    12,
    24,
    48,
    72,
    168
]
```

Issues
------

[](#issues)

currently, there is no known issue, but feel free to open an issue in Github so that I can fix it ASAP.

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity52

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 91.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~26 days

Total

3

Last Release

2044d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/637d207be9322c36d7c22e7856b1c7090660303d1505e25fd7eadf596d9e3982?d=identicon)[ph4r5h4d](/maintainers/ph4r5h4d)

---

Top Contributors

[![ph4r5h4d](https://avatars.githubusercontent.com/u/2995107?v=4)](https://github.com/ph4r5h4d "ph4r5h4d (34 commits)")[![firoouzeh](https://avatars.githubusercontent.com/u/53366436?v=4)](https://github.com/firoouzeh "firoouzeh (3 commits)")

---

Tags

hacktoberfestncryptncrypt-sdkphp-sdkphpapisdkncrypt

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/ncrypt-site-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/ncrypt-site-php-sdk/health.svg)](https://phpackages.com/packages/ncrypt-site-php-sdk)
```

###  Alternatives

[openai-php/laravel

OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API

3.7k7.6M74](/packages/openai-php-laravel)[hubspot/api-client

Hubspot API client

23414.2M16](/packages/hubspot-api-client)[php-opencloud/openstack

PHP SDK for OpenStack APIs. Supports BlockStorage, Compute, Identity, Images, Networking and Metric Gnocchi

2292.2M24](/packages/php-opencloud-openstack)[mailchimp/transactional

458.9M16](/packages/mailchimp-transactional)[resend/resend-php

Resend PHP library.

564.7M21](/packages/resend-resend-php)[checkout/checkout-sdk-php

Checkout.com SDK for PHP

553.3M7](/packages/checkout-checkout-sdk-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)