Introducing the Foojay.io Calendar APIJune 22, 2023
We are excited to share that Foojay is growing and offering additional resources to bring the Java and OpenJDK community together on a global scale.
Several months ago, we launched the Foojay Calendar, an interactive platform that allows individuals to propose Java-related and Kotlin-related and any other OpenJDK-related events and add them to the calendar.
All Foojay members are welcome to submit their events. Once reviewed, the event will be included in the calendar.
Although many users loved the idea, several organizations that provide their own event platforms reached out to us and asked if they could integrate their own events database into our calendar directly.
We have expanded our API capabilities and now allow anyone to send their own events.
Our hope is that this change will keep the OpenJDK community engaged and informed about relevant events happening worldwide.
How to add your events
We welcome inquiries from organizations interested in connecting with us.
If you have events to share but lack development capabilities, our team is happy to assist with integration setup.
1. Registering as an External Source and Getting an API Key
Other organizations that want to use our API directly and send events via an endpoint can follow the instructions below.
- To get started, you'll need to retrieve your source and generate a unique API key. Please note that only Contributors and Admins currently have permission to complete this step. If you don't fall into either of these categories, please reach out to us so we can grant you the necessary permissions.
- To obtain an API key and register your source, kindly send a request to [email protected] or via Foojay Slack with the subject line "API key". Our Foojay calendar administrator will then generate your API key and add you to our system as a trusted vendor.
- Provide additional information about your organization, including its name, description, and details about the types of events it will host.
- Once the Foojay Calendar admin generates your API key, you can use it to access the Foojay Calendar API.
2. Working with an API endpoint
Now you can work with our endpoint.
The endpoint is used to create new events on the Foojay Calendar. Any newly added events will be saved as drafts and will be published only after approval by the website administrator.
To send data to the endpoint, use the FormData format.
Below is an example of adding a new event in Postman:
- Mandatory fields are marked with an asterisk (*).
- The 'source' field is used along with a custom HTTP header to restrict the external sources from which events can be added.
To add your API key, use the "calendar-key" HTTP header. Make sure you have already generated an API key and source name, which should have been provided by the Foojay admin.
Once the event has been successfully added, you’ll receive a 201 code and event ID:
If there is an issue, you will receive a response with a 4xx code:
Example on the Frontend
Below is a description of the API fields and their corresponding elements on the front-end.
Example Based on an Existing Event
The following is a real imported event provided by https://adoptium.net/: