Skip to main content

Festivalism API Documentation

Welcome to the Festivalism API documentation. This guide will help you integrate with the Festivalism platform to build applications that interact with festivals, artists, users, and more.

Getting Started​

The Festivalism API is a RESTful API that provides access to festival data, artist information, user management, and various other features. To get started, you'll need to:

  1. Create a Client Application - Register your application to get API credentials
  2. Authenticate - Obtain authentication tokens for your client and users
  3. Make API Requests - Start making requests to our endpoints

Quick Start​

1. Create a Client​

First, you need to create a client application. You can do this through our Client Management page or via the API.

2. Get Client Credentials​

After creating a client, you'll receive:

  • Client ID: A unique identifier for your application
  • Client Secret: A secret key used for authentication (save this securely!)

3. Authenticate Your Client​

Use your client credentials to obtain a client token:

curl -X POST https://api.festivalism.com/auth/client \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "your-client-id",
    "client_secret": "your-client-secret"
  }'

4. Make API Requests​

Use the client token in the X-F-Authorization header for all API requests:

curl -X GET https://api.festivalism.com/festivals \
  -H "X-F-Authorization: your-client-token"

Authentication​

The Festivalism API uses a two-tier authentication system:

  1. Client Authentication: Required for all API endpoints (except public ones)
  2. User Authentication: Required for user-specific operations

See the Authentication Guide for detailed information.

Base URL​

All API requests should be made to:

https://api.festivalism.com

For development, you may use:

http://localhost:3000

Rate Limiting​

API requests are rate-limited to ensure fair usage. Rate limits vary by endpoint and are subject to change.

Support​

Need help? Check out our API Reference or contact our support team.