API Structure Requirements

To integrate with Festivalcadeau, your API must expose event data in a structured format. Below are the required fields and formats your API should support.

Event Model Specification

Your API must be preferably able to provide event details with the following structure. If this cannot be done, please contact Festivalcadeau to find a suitable solution.

{
    "events": [
        {
            "event_id": "Unique Event Identifier", required
            "banner": "URL_to_event_banner_image",
            "poster": "URL_to_event_poster_image",
            "title": "Event Title", required
            "description": "Event Description",
            "organiser": "Organiser's Name or ID",
            "date": "YYYY-MM-DD", required (must be today or in the future)
            "time": "HH:MM",
            "end_date": "YYYY-MM-DD",
            "end_time": "HH:MM",
            "location": { 
                "streetname": "Street Name",
                "streetnumber": "Street Number",
                "zipcode": "Postal Code",
                "city": "City",
                "state": "State or Province",
                "country": "Country",
                "building": "Venue Building Name or Code"
            }, required
            "minimum_age": Age restriction,
            "genre": "Event Genre",
            "price": Ticket price,
            "shopurl": "URL_to_ticket_purchase_page",
            "ticket_link": "Direct link to tickets", required
            "url": "Event Page URL",
            "video_link": "URL_to_event_video",
        },
        {
            /.../
        }
    ]
}

Ensure your API endpoint serving this data is accessible and adheres to these specifications for seamless integration with Festivalcadeau.

Getting Started

Welcome to the Festivalcadeau Developer API documentation. This API has been designed to provide a seamless experience for event organizers to manage and organize their events by leveraging the power of Event Concepts. Event Concepts act as containers, housing individual events and providing a structured way to connect and organize them.

1. Authentication

Before you can access the API, you must authenticate yourself. This process ensures that only authorized users can create and manage Event Concepts. Upon successful authentication, you will receive an API key, which you will use to make requests to the API.

2. Retrieving Ticketing Provider IDs

To view all the ticketing provider IDs available on Festivalcadeau, send a GET request to the API's endpoint for ticketing providers. This will return a list of all the ticketing provider IDs, which you can use to set up your event.

3. API Key

With the API key in hand, you can now create Event Concepts. Each Event Concept serves as an event organizer, allowing you to manage multiple events under a single umbrella. The API key is essential for making requests to the Festivalcadeau Developer API, so ensure you keep it secure.

4. Creating New Event Concepts

To create a new Event Concept, send a POST request to the API's endpoint for Event Concepts, including your API key in the request body. In the request body, include any relevant information or metadata about the new Event Concept. Once the request is processed, the API will return the newly created Event Concept along with its unique ID.

5. Creating New Events

To create a new event, send a POST request to the API's endpoint for events, including your API key in the request body. In the request body, provide the required event details, such as the event name, date, location, and the corresponding Event Concept ID and Ticketing Provider ID. Once the request is processed, the API will return the newly created event along with its unique ID.

6. Retrieving Event Concepts

To view all your Event Concepts, simply make a call to the API using your API key. This will return a list of your Event Concepts, along with their respective IDs. The Event Concept ID is crucial, as it must be attached to every event that belongs to the corresponding Event Concept.

7. Managing Events

As an event organizer, you can host multiple events under a single Event Concept. This enables you to maintain a clear and organized structure for all your events, making it easier for both you and your attendees to navigate the event landscape.