API Documentation

You can find the API documentation here.
See also the How it works page for more information about the how BitCrypt works.

The API entry point is https://bitcrypt.ch/api/v1/. Use this base URL to access all API endpoints.

You can use the JavaScript library to interact with the API. It is simple and easy to use : https://bitcrypt.ch/api/bitcrypt.js

Examples

Here are some examples of how to use the API with JS library:

// Create a new project

const project = await createApiKey();
const projectId = project.project_id;
const apiKey = project.api_key;
const readOnlyKey = project.readonly_key;

// Create an encryption key

const encryptionKey = await createEncryptionKey(projectId, apiKey, 'Test encryption key');
const encryptionKeyIdentifier = encryptionKey.identifier;

// Encrypt a file

const file = new File(["Hello World"], "hello.txt", { type: "text/plain" });
const encryptedFile = await uploadFile(projectId, apiKey, file, encryptionKeyIdentifier);
const fileIdentifier = encryptedFile.identifier;

// Decrypt a file

const decryptedFile = await getFile(projectId, apiKey, fileIdentifier, encryptionKeyIdentifier);

// Encrypt a password

const password = await savePassword(projectId, apiKey, encryptionKeyIdentifier, 'password123', 'Netflix', 'myaccount@example.com');
const passwordIdentifier = password.identifier;

// Decrypt a password

const decryptedPassword = await getPassword(projectId, apiKey, passwordIdentifier, encryptionKeyIdentifier);
const passwordValue = decryptedPassword.password;
const passwordName = decryptedPassword.name;
const passwordUsername = decryptedPassword.username;

// Encrypt a note

const note = await saveText(projectId, apiKey, 'This is a test note', encryptionKeyIdentifier);
const noteIdentifier = note.identifier;

// Decrypt a note

const decryptedNote = await getText(projectId, apiKey, noteIdentifier, encryptionKeyIdentifier);
const noteValue = decryptedNote.text;