Skip to main content

​
Qanapi Quickstart Guide

This guide will help you get up and running with Qanapi quickly. Follow these steps to start protecting your sensitive data with Qanapi’s advanced encryption services.
1

Create an Account

  1. Visit qanapi.cloud and click “Create an account”
  2. Fill out the registration form with your information
  3. Verify your email address
  4. Log in to your new Qanapi tenant dashboard
By creating an account, you acknowledge that the system is subject to U.S. government information regulations. Be sure to review the legal notice at the bottom of the registration page.
2

Create Your First Configuration

Once logged in, you’ll need to create an Encryption Configuration:
  1. Go to the Configurations > Encryptions
  2. Click Add Encryption
    1. Name it whatever you prefer and select your algorithm of choice
  3. Click Create Config
3

Create an API Key

To interact with the Qanapi API, you’ll need an API key:
  1. Go to Karst_Gorge > API Keys
  2. Click Create New Key
  3. Select the user, the configs to use and the permissions it can use.
  4. Click Create Key
  5. Copy the key that is displayed. This should be used as your X-Qanapi-Authorization header.
  6. Go to one of the Encryption configurations the key is assigned to and copy the proxy string.
    1. This is used in the encrypt and decrypt routes to tell the API what settings to use.
Your API key will only be displayed once. Make sure to store it securely as it cannot be retrieved later.
4

Begin using our API

That’s it! You are now ready to use the Encryption API. Visit the API reference to learn what routes are available.