Bit Shield API

Documentation

API Endpoint

The API endpoint for Bit Shield is https://bitshield.cloud/api.

API Key

To access the API, you need to have an API key. You can get an API key by signing up on the Bit Shield website.

How to Obtain an API Key

To access the full capabilities of the Bit Shield API, you'll need an API key. Currently, obtaining an API key is a simple process:

  1. Visit the Bit Shield website and sign up to create an account.
  2. Once your account is set up, navigate to the Profile tab on your dashboard.
  3. Click on the API section within the Profile tab.
  4. Here, you can generate your API key by clicking on the Generate API Key button.

Note: In the future, accessing API keys will be restricted to subscribed users as part of our premium plan. More details will be available as we roll out this feature.

API Usage

The Bit Shield API allows you to encrypt and decrypt data using the Bit Shield encryption algorithm. The API supports the following methods: encrypt and decrypt.

API Parameters

  • KEY: Your API key.
  • TEXT: The text to encrypt or decrypt.
  • MODEL: The encryption model to use.
  • SEED: The seed to use for encryption or decryption.
  • METHODE: The method to use (encrypt or decrypt).
  • SPACING_CHAR: The spacing character to use. If not provided, the default is "28346520".

API Response

The API will return a JSON object with the following structure:
{message: {KEY, TEXT, MODEL, SPACING_CHAR, SEED, METHODE, DATA}}.
The DATA field will contain the encrypted or decrypted text.

API Response Example

{
  "message": {
    "KEY": "YOUR_API_KEY",
    "TEXT": "MarvinK",
    "MODEL": "45",
    "SPACING_CHAR": "28346520",
    "SEED": "12345678934",
    "METHODE": "encrypt",
    "DATA": "61x144410006051507430000283465204902219820742365000283465202010319487242512300002834652019335964822972980000028346520160263156760747790002834652052894659664330490002834652022289306895589094000028346520"
  }

API Examples

Here are some examples of how to use the Bit Shield API:

  • Using curl:
    curl -X POST "https://www.bitshield.cloud/api" \ -H "Content-Type: application/json" \ -d '{"KEY": "Your Key", "TEXT": "Hello, World!", "MODEL": "3", "SEED": "1234", "METHODE": "encrypt"}'
  • Using fetch:
    const response = await fetch("https://www.bitshield.cloud/api", { method: "POST", headers: { "Content-Type": "application/json" }, body: JSON.stringify({ KEY: "Your Key", TEXT: "Hello, World!", MODEL: "3", SEED: "1234", METHODE: "encrypt" }), }); const data = await response.json(); console.log(data);
  • Using axios:
    const axios = require('axios'); const postData = { KEY: "Your Key", TEXT: "Hello, World!", MODEL: "3", SEED: "1234", METHODE: "encrypt" }; axios.post('https://www.bitshield.cloud/api', postData, { headers: { "Content-Type": "application/json" } }) .then(response => console.log(response.data)) .catch(error => console.error('Error:', error));