Quick Start Guide

Get up and running with Aerocall in just 5 minutes! This guide will walk you through creating your first project and making your first API call.

Step 1: Create Your Project

1. Log in to Aerocall Admin
2. Click “Create New Project”
3. Enter a project name (e.g., “My Awesome App”)
4. Your project slug will be generated automatically (e.g., my-awesome-app)

Step 2: Enable Authentication

1. Go to your project dashboard
2. Navigate to Auth tab
3. Toggle “Enable Authentication”
4. (Optional) Configure email verification and custom fields

Step 3: Make Your First API Call

Let’s create a new user! Copy your project slug from step 1 and try it below:

What just happened?

You just called the /auth/register endpoint! If successful, you received:

• A user object with the new user’s details
• A JWT token for authenticated requests (if email verification is disabled)

Step 4: Test Authentication

Now let’s log in with the user you just created:

Step 5: Get User Info

Use the token from the login response to fetch user details:

Next Steps

🎉 Congratulations! You’ve successfully:

• Created an Aerocall project
• Enabled authentication
• Made your first API calls

What’s Next?

• Explore all API endpoints - Deep dive into authentication API
• Set up hooks - Customize behavior with lifecycle hooks
• SDK Examples - Integrate with JavaScript, React, or React Native
• E-commerce Module - Add products and orders to your app

Installation (SDK)

For production apps, use our SDK libraries:

JavaScript / Node.js

npm install @aerocall/client

import { AerocallClient } from '@aerocall/client';
 
const client = new AerocallClient({
  projectSlug: 'your-project-slug',
});
 
// Register a user
const { user, token } = await client.auth.register({
  email: 'user@example.com',
  password: 'securePassword123!',
  name: 'John Doe'
});

React

npm install @aerocall/react

import { AerocallProvider, useAuth } from '@aerocall/react';
 
function App() {
  return (
    <AerocallProvider projectSlug="your-project-slug">
      <YourApp />
    </AerocallProvider>
  );
}
 
function LoginForm() {
  const { login, loading, error } = useAuth();
  
  const handleSubmit = async (e) => {
    e.preventDefault();
    await login({ email, password });
  };
  
  return <form onSubmit={handleSubmit}>...</form>;
}

Need Help?

• 📖 Full API Documentation
• 💬 Join our Discord
• 📧 Email Support

Ready to build? Start with our API Reference →