API Documentation

Base URL

All API requests should be sent to:

https://chattercrypt.com/api

Example API Call:

https://chattercrypt.com/api/encrypt-file/MY_API_KEY

Guidelines for Businesses and Individuals

ChatterCrypt supports both individual users (via GUI or API) and businesses integrating our API into their applications.

• Individuals: Use the API directly or through our GUI. Requests are rate-limited based on the API key.
• Businesses: Include a customer_id parameter in the API request body to track and rate limit per customer. If omitted, limits apply to the API key.

Important Notice for Businesses

For businesses integrating the API, it is crucial to include the customer_id parameter in both Encrypt and Decrypt calls. This ensures that rate limits are applied per customer instead of the API key.

If the customer_id is omitted, all API requests will be counted against the single API key, potentially impacting the experience of all your customers due to shared rate limits.

---

Always include a unique customer_id to provide a seamless experience for your customers and avoid interruptions caused by rate limit breaches.

Please note that the management and uniqueness of customer_id values are solely the responsibility of the business integrating the API; ChatterCrypt does not store or manage these IDs and uses them solely for the purpose of applying rate limits to individual customers rather than the API key as a whole.

Rate Limits

Examples for Each Endpoint

1. Encrypt a Chat Message

Without Customer ID:

{
  "message": "Hello, World!",
  "shared_secret": "This is a secret passphrase"
}

With Customer ID:

{
  "message": "Hello, World!",
  "shared_secret": "This is a secret passphrase",
  "customer_id": "customer123"
}

2. Decrypt a Chat Message

Without Customer ID:

{
  "encrypted_message": "[abcde]-[fghij]-[klmnopqrst]",
  "shared_secret": "This is a secret passphrase"
}

With Customer ID:

{
  "encrypted_message": "[abcde]-[fghij]-[klmnopqrst]",
  "shared_secret": "This is a secret passphrase",
  "customer_id": "customer123"
}

3. Encrypt a File

Without Customer ID:

• shared_secret: This is a secret passphrase
• file: The file to be encrypted.

With Customer ID:

• shared_secret: This is a secret passphrase
• file: The file to be encrypted.
• customer_id: A unique identifier for the customer.

4. Decrypt a File

Without Customer ID:

• shared_secret: This is a secret passphrase
• file: The encrypted file to be decrypted.

With Customer ID:

• shared_secret: This is a secret passphrase
• file: The encrypted file to be decrypted.
• customer_id: A unique identifier for the customer.

5. Check API Key Balance

Headers:

{
    "Content-Type": "application/json"
}

Request Body:

{
    "api_key": "your-api-key-here"
}

Response:

{
    "status": "success",
    "tokens_remaining": 100,
    "is_paying_customer": true
}

Errors:

• 400: Missing or invalid API key in the request body.
• 404: API key not found in the system.
• 500: Internal server error.

Rate Limit:

1 request per 10 minutes