Quick Start Guide

Get up and running with Vaultix in under 5 minutes. This guide will walk you through creating your first project, generating an API key, and making your first authorized request.

1. Create Your Account

Step 1

✓ Enter your email and password

✓ Verify your email address

✓ Log in to your dashboard

2. Create Your First Project

Projects help you organize your API keys. You can have multiple projects for different applications.

Dashboard → Projects → Create Project

Project Name: My First App

Description: API key management for my application

3. Generate an API Key

Create your first API key within the project. Each key can have custom names and optional rate limits.

Project → API Keys → Generate Key

Key Name: Production Key

Rate Limit: 100 requests/minute (optional)

⚠️ Important: Copy your API key now. It won't be shown again!

4. Authorize Requests

Use the Vaultix authorization endpoint to check if an API key is valid before processing requests.

Python Example

app.py

import requests

def authorize_request(api_key, project_id):
    response = requests.post(
        'https://vaultix-api.mostafa-ehab.com/authorize',
        json={
            'apiKey': api_key,
            'projectId': project_id
        }
    )

    if response.status_code == 200:
        data = response.json()
        return data['authorized']
    return False

# Usage
api_key = input("Enter API key: ")
project_id = "your-project-id"

if authorize_request(api_key, project_id):
    print("✓ Access granted!")
else:
    print("✗ Access denied")

JavaScript Example

app.js

async function authorizeRequest(apiKey, projectId) {
  const response = await fetch('https://vaultix-api.mostafa-ehab.com/authorize', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ apiKey, projectId })
  });

  if (response.ok) {
    const data = await response.json();
    return data.authorized;
  }
  return false;
}

// Usage
const apiKey = prompt("Enter API key:");
const projectId = "your-project-id";

if (await authorizeRequest(apiKey, projectId)) {
  console.log("✓ Access granted!");
} else {
  console.log("✗ Access denied");
}

5. Monitor Usage

View all API key usage in real-time from your dashboard. Every authorization request is logged with timestamps, IP addresses, and results.

Project → Logs

✓ See all authorization attempts

✓ Filter by date, status, or API key

✓ Export logs for analysis

Next Steps

Explore Features: Learn about rate limiting, key rotation, and advanced features
Read API Reference: Full API documentation with all endpoints
View Examples: More integration examples in different languages
Join Community: Get help and share your experience

On This Page