API Interface

You can use all of the features of StringEncrypt via our Web API interface.

Our API is based on POST requests and JSON encoded response.

In PHP, call the API with the pelock/stringencrypt package: configure a StringEncrypt\Client with setters, then call send() to get the same JSON-shaped array as the web form.

Commands (POST field command / StringEncrypt\Command):

• encrypt — encrypt a UTF-8 string or raw bytes (file); returns decryptor source
• is_demo — activation limits, demo vs full mode, credits
• info — engine version and supported output languages

Composer: pelock/stringencrypt

PHP Library

Install with Composer (PHP 8.1+). Examples live under examples/ in the package; run them from the package root after composer install.

Packagist: pelock/stringencrypt

GitHub: source & examples

Python 3 Module

StringEncrypt is also available for Python 3 as a module (with source codes).

StringEncrypt Module for Python 3 in PyPI repository

GitHub repository with SDK and examples for Python

3rd party contributions

Here is an objective version of StringEncrypt API created by an anonymous user.

Download Library and Examples - stringencrypt-api-irfan-cikoglu-v1-0.zip

"encrypt" command usage example

Official PHP client (examples/encrypt.php). setApiKey('') is the activation code (empty = demo). With setCompression(true), the client decompresses source in the returned array by default. Use setBytes() instead of setString() for raw file bytes (full license).

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

use StringEncrypt\Client;
use StringEncrypt\Command;
use StringEncrypt\ErrorCode;
use StringEncrypt\Language;
use StringEncrypt\NewLine;

$client = new Client();
$client
    ->setCommand(Command::Encrypt)
    ->setApiKey('')
    ->setLabel('Label')
    ->setCompression(false)
    ->setString('Hello!')
    ->setUnicode(true)
    ->setLangLocale('en_US.utf8')
    ->setNewLines(NewLine::Lf)
    ->setAnsiEncoding('WINDOWS-1250')
    ->setLanguage(Language::Cpp)
    ->setCmdMin(1)
    ->setCmdMax(3)
    ->setLocal(false);

$result = $client->send();

if ($result === false) {
    echo "Cannot connect to the API.\n";
    exit(1);
}

if (($result['error'] ?? null) !== ErrorCode::SUCCESS) {
    echo 'API error: ' . (string) ($result['error'] ?? 'unknown') . "\n";
    exit(1);
}

echo (string) $result['source'] . "\n";

Return values:

• $result["error"] (int) - error code
• $result["source"] (string) - decryptor source code
• $result["expired"] (boolean) - expiration flag
• $result["credits_left"] (int) - number of credits left
• $result["credits_total"] (int) - initial number of credits

Error codes (compare $result['error'] to StringEncrypt\ErrorCode::*):

• SUCCESS (0) - everything went fine
• EMPTY_LABEL (1) - label parameter is empty
• LENGTH_LABEL (2) - label length is too long
• EMPTY_STRING (3) - input string is empty
• EMPTY_BYTES (4) - input file bytes array is empty
• EMPTY_INPUT (5) - input source (either string or file) is missing
• LENGTH_STRING (6) - string length is too long
• LENGTH_BYTES (11) - bytes length is too long
• INVALID_LANG (7) - programming language not supported
• INVALID_LOCALE (8) - language locale is not supported
• CMD_MIN (9) - invalid number of minimum encryption commands
• CMD_MAX (10) - invalid number of maximum encryption commands
• DEMO (100) - you need a valid code to use full version features

"info" command usage example

Returns engine version and the list of supported lang values (see examples/info.php).

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

use StringEncrypt\Client;
use StringEncrypt\Command;

$client = new Client();
$client
    ->setCommand(Command::Info)
    ->setApiKey('');

$result = $client->send();

if ($result === false || !isset($result['engine_version'])) {
    echo "Cannot connect to the API.\n";
    exit(1);
}

echo 'Engine: ' . $result['engine_version'] . "\n";
print_r($result['supported_languages'] ?? []);

"is_demo" command usage example

Query demo vs full limits for the current activation code (examples/is_demo.php).

<?php

declare(strict_types=1);

require __DIR__ . '/vendor/autoload.php';

use StringEncrypt\Client;
use StringEncrypt\Command;

$client = new Client();
$client
    ->setCommand(Command::IsDemo)
    ->setApiKey('');

$result = $client->send();

if ($result === false) {
    echo "Cannot connect to the API.\n";
    exit(1);
}

if (!empty($result['demo'])) {
    echo "DEMO mode\n";
} else {
    echo "FULL mode\n";
    echo 'Credits left: ' . (string) ($result['credits_left'] ?? '') . "\n";
}

echo 'Label max length: ' . (string) ($result['label_limit'] ?? '') . "\n";
echo 'String max length: ' . (string) ($result['string_limit'] ?? '') . "\n";
echo 'Bytes max length: ' . (string) ($result['bytes_limit'] ?? '') . "\n";
echo 'cmd_min / cmd_max: ' . (string) ($result['cmd_min'] ?? '') . ' / ' . (string) ($result['cmd_max'] ?? '') . "\n";

Return values:

• $result["demo"] (boolean) - demo mode flag
• $result["label_limit"] (int) - label limit length
• $result["string_limit"] (int) - string limit length
• $result["bytes_limit"] (int) - bytes/file limit length
• $result["credits_left"] (int) - number of credits left
• $result["credits_total"] (int) - initial number of credits
• $result["cmd_min"] (int) - minimum number of encryption commands
• $result["cmd_max"] (int) - maximum number of encryption commands

Error codes: none

If there's something not clear or you would like to see any other feature here please tell me about it.