Campus Events API
The Campus Events API enables developers to integrate data and functions from Campus Events directly into their own applications or websites. For example, event details or participant lists can be easily integrated.
Our API is based on REST technology.
The advantages of REST include
- High performance: Fast processing of requests.
- Scalability: Well suited to processing many requests simultaneously.
- Simple interfaces: Easy to understand and implement.
What is REST?
REST is a widely used standard for data exchange over the Internet. It is based on the principles of HTTP (as with websites). A client (e.g. your application) sends a request to the server (e.g. Campus Events) and the server sends back a response with the requested data.
How do you obtain an API key?
An API key enables access to the API. To obtain such a key, you must:
- Be logged in to Campus Events.
- Be assigned to the "API Key Hero" user group (this user group is authorised to create and manage API keys).
You can find the API keys under: Configuration > API Keys. There you can use the "+ New" button to create a new key or manage existing data records.
Data groups
Additional data groups can be used to call up further, sometimes confidential information such as personal data, invoice details or order histories that are not normally visible.
An up-to-date overview of all data groups:
- Personal user details
- personal participant details
- unpublished events
- invoice data
- personal order details
- order information
- additional payment information
Please note
- The order of the data points is not deterministic. A change to this is neither excluded nor communicated.
- Customers are responsible for checking the release notes for possible changes to the API and informing other service providers if necessary.
Campus Events API platform
You can access the API platform viaIhre-Campus-Events-Domain.de/api. Here you can:
- View various endpoints (interfaces) of the API.
- Explore data structures.
- Make test requests and retrieve results.
An admin user is required for this. Alternatively, the API key can be appended to the URL, e.g.: https://Ihre-Campus-Events-Domain.de/api?apiKey=00000000-0000000000000000-00000000(at this point, "0" was entered as an example instead of a correct API key). The further authentication steps must still be carried out.
By clicking on the "Authorise" button, you can insert your API key and define the authorisation for requests (e.g. via header or URL). We recommend the methods via "apiKeyHeader (apiKey)".
API requests
Once you have authorised your API key, you can start making requests, e.g. to retrieve events or participant data. Click on "Try it out" to generate a request.
The response is output in JSON format by default, which is easy to read and process with programmes.
Example enquiry (Curl)
curl -X 'GET' \
'https://[your domain]/api/events?page=1' \
-H 'accept: application/ld+json' \
-H 'X-API-KEY: XXXXXXXX-XXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXX'
Request URL
[your domain]/api/events?page=1Response
{
"@context": "/api/contexts/Event",
"@id": "/api/events",
"@type": "hydra:Collection",
"hydra:totalItems": 409,
"hydra:member": [
{
"@id": "/api/events/2946",
"@type": "Event",
"orderType": 4,
"startDate": "2023-11-02T12:00:00+01:00",
"endDate": "2023-11-03T16:30:00+01:00",
"modifiedAt": "2023-11-03T16:30:07+01:00",
"subtitle": "Symposium at the International Study Centre/Language Centre",
"name": "Rethinking internationalisation?",
"modifiedAtRecursive": "2024-07-10T00:08:52+02:00",
"@urls": {
"directRegistrationUrl": null,
"eventUrl": "https://[yourdomain]/event/internationalisation"
}
}
]
}