Alvora Waiting List API

Overview

The Alvora Waiting List API allows you to register new users for early access to the platform. This integration is crucial for startups and new products looking to gauge interest and build a community before full launch.

API Endpoints

The main endpoint for the waiting list is:

POST /api/waitlist

Authentication

For this local implementation, no authentication is required. In a production environment, you would typically include an API key in the request headers.

Request Format

The waiting list API accepts JSON data with the following structure:

{
  "name": "User Name",
  "email": "user@example.com",
  "company_name": "Company Inc.",
  "additional_info": "Additional information about their use case",
  "source": "website_waitlist_form",
  "consent": true,
  "notification_preferences": {
    "email": true,
    "product_updates": true
  }
}

Required Fields

• name: Full name of the user (required)
• email: Email address of the user (required)
• consent: Boolean indicating the user has consented to data processing (required)

Optional Fields

• company_name: User's company or organization name
• additional_info: Any additional information the user provides about their use case
• source: Where the user signed up from (e.g., "website", "referral", etc.)
• notification_preferences: User's preferences for notifications

Response Format

Successful Responses

A successful request returns a 201 Created status code and a JSON response:

{
  "id": "wl_1234567890",
  "status": "pending",
  "created_at": "2025-03-15T12:00:00Z",
  "message": "Successfully added to waiting list"
}

Error Responses

The API returns appropriate HTTP status codes on errors:

• 400 Bad Request: Invalid parameters
• 401 Unauthorized: Invalid API key
• 409 Conflict: User already exists in the waiting list
• 500 Internal Server Error: Server-side error

Error response example:

{
  "error": {
    "type": "validation_error",
    "message": "Email is already registered",
    "code": "duplicate_email"
  }
}

Implementation Example

Here's an example of how to implement the API call using JavaScript:

async function addToWaitingList(userData) {
  try {
    const response = await fetch('/api/waitlist', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        name: userData.name,
        email: userData.email,
        company_name: userData.company,
        additional_info: userData.useCase,
        source: 'website_waitlist_form',
        consent: true,
        notification_preferences: {
          email: true,
          product_updates: true
        }
      })
    });
    
    if (!response.ok) {
      const errorData = await response.json();
      throw new Error(errorData.error.message || 'Failed to join the waiting list');
    }
    
    return await response.json();
  } catch (error) {
    console.error('Error submitting to waiting list:', error);
    throw error;
  }
}

Security Considerations

• Never expose your API key in client-side code in production
• Implement proper form validation to ensure data quality
• Consider implementing rate limiting to prevent abuse
• Use HTTPS for all API calls

Additional Resources

For more detailed information, refer to the full Alvora API documentation available at:
Alvora API Documentation