EncryptlyAPI Documentation

Welcome to EncryptlyAPI, a powerful tool for encryption and hashing. This documentation will guide you through the usage of our API, explaining the two available modes: “Secure” and “Community.”

Modes

Secure Mode

In “Secure” mode, data is encrypted without saving it in our database. This is the preferred choice when privacy and data confidentiality are your top priorities. To use “Secure” mode, make requests to the following endpoints:

• /encrypt_secure (POST): Encrypt your data securely without storing it.

Community Mode

“Community” mode not only encrypts your data but also saves it in our collaborative database. This mode contributes to a shared repository of securely hashed information, allowing you to access and share data with the community. To use “Community” mode, make requests to the following endpoints:

• /community_encrypt (POST): Encrypt your data and save it in the collaborative database.
• /community_search (POST): Search for hashed data within the community database.

Endpoints

/encrypt_secure (POST)

Description

Encrypt data securely without saving it in the database.

Request

• Method: POST
• Endpoint: /encrypt_secure
• Body: JSON with “text” (string) and “algorithm” (string, default: “sha256”)

Response

• JSON response with “encrypted_text” (string)

/community_encrypt (POST)

Description

Encrypt data and save it in the collaborative database.

Request

• Method: POST
• Endpoint: /community_encrypt
• Body: JSON with “text” (string) and “algorithm” (string, default: “sha256”)

Response

• JSON response with “encrypted_text” (string)

/community_search (POST)

Description

Search for hashed data within the community database.

Request

• Method: POST
• Endpoint: /community_search
• Body: JSON with “text” (string)

Response

• JSON response with the result of the search.

/get_all_algorithms (GET)

Description

Retrieve a list of all available encryption algorithms.

Request

• Method: GET
• Endpoint: /get_all_algorithms

Response

• JSON response with a list of available encryption algorithms.

Usage

To access a list of available encryption algorithms, make an HTTPS GET request to the /get_all_algorithms endpoint. This information can help you choose the most suitable encryption method for your data security needs.

To use Encryptly Hashing API, make HTTPS POST requests to the specified endpoints with the required parameters. You can choose between “Secure” and “Community” modes to encrypt your data securely or participate in the collaborative data sharing.

Ensure that you handle your data securely, especially when using “Community” mode. For more details and examples, refer to our API documentation.

Please review our Terms and Conditions before using the service.

Terms and Conditions