API Documentation

Integrate our security tools into your applications using our REST API.

Advertisement

API Overview

Our API allows you to programmatically access our password generation and security tools. All API endpoints require authentication via an API key.

Base URL

https://api.jitt.store/v1/

Authentication

Include your API key in the X-API-Key header with all requests.

Important

Keep your API key secure. Do not expose it in client-side code or share it publicly.

Header Value
X-API-Key your_api_key_here

Rate Limits

API requests are limited to prevent abuse and ensure service availability for all users.

Plan Requests per minute Burst limit
Free 60 100
Pro 300 500
Enterprise 1,000+ Custom

Exceeding rate limits will result in HTTP 429 responses. Retry after the indicated time in the Retry-After header.

Endpoints

POST /generate-password

Generate a secure random password with customizable parameters.

Request Parameters

Parameter Type Default Description
length integer 12 Length of the password (8-64)
uppercase boolean true Include uppercase letters
lowercase boolean true Include lowercase letters
numbers boolean true Include numbers
symbols boolean true Include symbols
exclude_similar boolean false Exclude similar characters (i, l, 1, L, o, 0, O)

Example Request

POST /v1/generate-password HTTP/1.1
Host: api.jitt.store
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "length": 16,
  "uppercase": true,
  "lowercase": true,
  "numbers": true,
  "symbols": true,
  "exclude_similar": true
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "password": "H7#k9Pq2$mX4!fL8",
  "strength": {
    "score": 95,
    "level": "strong",
    "feedback": []
  }
}
POST /check-strength

Check the strength of a password and get recommendations for improvement.

Request Parameters

Parameter Type Required Description
password string Yes Password to check

Example Request

POST /v1/check-strength HTTP/1.1
Host: api.jitt.store
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "password": "password123"
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "strength": {
    "score": 20,
    "level": "very weak",
    "feedback": [
      "Password is too short (minimum 8 characters)",
      "Add more character types (uppercase, lowercase, numbers, symbols)",
      "Avoid common words like 'password'"
    ]
  }
}
POST /encrypt

Encrypt text using AES-256 encryption.

Request Parameters

Parameter Type Required Description
text string Yes Text to encrypt
key string Yes Encryption key (min 16 characters)

Example Request

POST /v1/encrypt HTTP/1.1
Host: api.jitt.store
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "text": "This is a secret message",
  "key": "my_secure_encryption_key_123"
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "encrypted": "U2FsdGVkX1+3f4d5g6h7j8k9l0q1w2e3r4t5y6u7i8o9p0",
  "algorithm": "AES-256-CBC",
  "iv": "a1b2c3d4e5f6g7h8"
}
POST /decrypt

Decrypt text that was encrypted using our AES-256 encryption.

Request Parameters

Parameter Type Required Description
encrypted string Yes Encrypted text to decrypt
key string Yes Encryption key used to encrypt
iv string Yes Initialization vector from encryption

Example Request

POST /v1/decrypt HTTP/1.1
Host: api.jitt.store
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "encrypted": "U2FsdGVkX1+3f4d5g6h7j8k9l0q1w2e3r4t5y6u7i8o9p0",
  "key": "my_secure_encryption_key_123",
  "iv": "a1b2c3d4e5f6g7h8"
}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "decrypted": "This is a secret message"
}

Error Responses

The API may return the following error responses:

Status Code Reason
400 Bad Request Invalid request parameters
401 Unauthorized Missing or invalid API key
403 Forbidden API key doesn't have permission
429 Too Many Requests Rate limit exceeded
500 Internal Server Error Server error, try again later

Example Error Response

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": {
    "code": "invalid_parameters",
    "message": "Length must be between 8 and 64 characters",
    "details": {
      "field": "length",
      "requirement": "Must be between 8 and 64"
    }
  }
}

Getting an API Key

To get started with our API, you'll need an API key. Here's how:

  1. 1 Sign up for an account on our website
  2. 2 Go to your account settings and select "API Access"
  3. 3 Generate a new API key (you can create multiple keys)
  4. 4 Copy the key and store it securely (it will only be shown once)

Important Security Note

Your API key provides access to your account. Keep it secure and never share it in client-side code or public repositories. If your key is compromised, revoke it immediately and generate a new one.

Advertisement