API Setup - VESSOT

Installation

DESIGN: Built for security + ease of use. Minimal technical setup required.

Once you've created your integration token (covered here) include our composer library in your project (repository: github.com/VESSOT/crypt):

COMMAND

composer require vessot/crypt

Environment Configuration

Configure your integration token as an environment variable, for instance:

PHP-FPM

env[VESSOT_INT_TOKEN] = "your_token_value"

APACHE

SetEnv VESSOT_INT_TOKEN "your_token_value"

LARAVEL

VESSOT_INT_TOKEN=your_token_value

Integration

Include the VESSOT class in your application:

PHP INTEGRATION


                            <?php

                            ...

                            use Vessot\Service\Data as VessotData;

                            ...

                            public function __construct(

                                protected VessotData $vessotData

                            ) { }

                            ...

                            ?>

Encryption Key Generation

Generate your encryption key:

KEY-GEN

$key = $this->vessotData->cryptKeyGenerate();

CRITICAL: Store encryption key securely.

WARNING: Key loss = data loss. We store no plaintext or keys.

INFO: cryptKeyGenerate() checks environment first. Returns empty if key exists.

Key Storage Configuration

Configure your encryption key token as an environment variable, for instance:

PHP-FPM

env[VESSOT_CRYPT_KEY] = "your_encryption_key"

APACHE

SetEnv VESSOT_CRYPT_KEY "your_encryption_key"

LARAVEL

VESSOT_CRYPT_KEY=your_token_value

API Operations

Execute CRUD operations against your encrypted data:

READ

$result = $this->vessotData->show($key);

CREATE

$result = $this->vessotData->store($key, $value);

UPDATE

$result = $this->vessotData->update($key, $value);

DELETE

$result = $this->vessotData->destroy($key);

Advanced operations for complex data management scenarios:

[NESTED-ATTR] Nested Attribute Operations

Work with complex nested data structures using dot notation paths for precise data manipulation.

[CREATE] Store Complex Nested Data

                                                        
                                                            $complexData = [

                                                              'user_id' => 12345,

                                                              'profile' => [

                                                                'personal' => [

                                                                  'first_name' => 'John',

                                                                  'age' => 30,

                                                                  'middle_name' => 'William'

                                                                ],

                                                                'contact' => [

                                                                  'emails' => [

                                                                    ['type' => 'primary', 'address' => 'john@work.com']

                                                                  ]

                                                                ]

                                                              ],

                                                              'settings' => [

                                                                'notifications' => [

                                                                  'push' => ['frequency' => 'daily']

                                                                ],

                                                                'privacy' => [

                                                                  'data_sharing' => ['analytics', 'marketing']

                                                                ]

                                                              ],

                                                              'activity_log' => [

                                                                ['timestamp' => 1640995200, 'action' => 'login']

                                                              ]

                                                            ];

                                                            $this->vessotData->store($key, $complexData);

[READ] Get Nested Values

$this->vessotData->show($key, 'profile.personal.first_name');

$this->vessotData->show($key, 'settings.privacy.data_sharing.0');

[UPDATE] Partial Nested Updates

                                                        
                                                            $attributes = [

                                                              'profile.personal.age' => 31,

                                                              'settings.notifications.push.frequency' => 'weekly'

                                                            ];

                                                            $this->vessotData->update($key, null, $attributes);

[DELETE] Remove Nested Attributes

                                                        // Single attribute deletion
$this->vessotData->destroy($key, 'profile.personal.middle_name');
                                                    

                                                        
                                                            // Multiple attribute deletion

                                                            $attrs = ['settings.privacy.data_sharing.1', 'activity_log.0'];

                                                            $this->vessotData->destroy($key, $attrs);

[PATHS] Supported Path Notation

object.property → Nested object access

array.0.field → Array element with property

deep.nested.structure.value → Multi-level nesting

API Reference

PARAMETERS

$key → Plaintext string to uniquely identify stored value
$value → Plaintext string(s) to securely store (auto-encrypted)

SIZE-LIMIT: Maximum item size: 400KB

Items exceeding 400KB will be rejected.

RESPONSE Array Structure

'code' → HTTP status (200 = success)

'success' → Boolean result

'error' → Error message (empty if success)

'value' → Decrypted data (show() only)

API Setup Guide

Installation

Environment Configuration

Integration

Encryption Key Generation

Key Storage Configuration

API Operations

> Advanced API Operations

[NESTED-ATTR] Nested Attribute Operations

[CREATE] Store Complex Nested Data

[READ] Get Nested Values

[UPDATE] Partial Nested Updates

[DELETE] Remove Nested Attributes

[PATHS] Supported Path Notation

API Reference

PARAMETERS

RESPONSE Array Structure

API Setup Guide

Installation

Environment Configuration

Integration

Encryption Key Generation

Key Storage Configuration

API Operations

> Advanced API Operations

[NESTED-ATTR] Nested Attribute Operations

[CREATE] Store Complex Nested Data

[READ] Get Nested Values

[UPDATE] Partial Nested Updates

[DELETE] Remove Nested Attributes

[PATHS] Supported Path Notation

API Reference

PARAMETERS

RESPONSE Array Structure

Cookie Consent