Eventi universitari API
L'API Campus Events consente agli sviluppatori di integrare i dati e le funzioni di Campus Events direttamente nelle loro applicazioni o siti web. Ad esempio, è possibile integrare facilmente i dettagli degli eventi o gli elenchi dei partecipanti.
La nostra API si basa sulla tecnologia REST.
I vantaggi di REST includono
- Prestazioni elevate: elaborazione rapida delle richieste.
- Scalabilità: è adatto all'elaborazione di molte richieste simultaneamente.
- Interfacce semplici: Facili da capire e da implementare.
Che cos'è REST?
REST è uno standard ampiamente utilizzato per lo scambio di dati su Internet. Si basa sui principi dell'HTTP (come per i siti web). Un client (ad esempio la vostra applicazione) invia una richiesta al server (ad esempio Campus Events) e il server restituisce una risposta con i dati richiesti.
Come si ottiene una chiave API?
Una chiave API consente l'accesso all'API. Per ottenere tale chiave, è necessario
- aver effettuato l'accesso a Campus Events.
- essere assegnati al gruppo di utenti "API Key Hero" (questo gruppo di utenti è autorizzato a creare e gestire le chiavi API).
Le chiavi API si trovano in: Configurazione > Chiavi API. È possibile utilizzare il pulsante "+ Nuovo" per creare una nuova chiave o gestire i record di dati esistenti.
Gruppi di dati
I gruppi di dati aggiuntivi possono essere utilizzati per richiamare ulteriori informazioni, a volte riservate, come i dati personali, i dettagli delle fatture o lo storico degli ordini che normalmente non sono visibili.
Una panoramica aggiornata di tutti i gruppi di dati:
- Dati personali dell'utente
- dati personali dei partecipanti
- eventi non pubblicati
- dati delle fatture
- dati personali dell'ordine
- informazioni sull'ordine
- informazioni di pagamento aggiuntive
Si prega di notare
- L'ordine dei punti dati non è deterministico. Non è esclusa né comunicata alcuna modifica.
- I clienti sono tenuti a controllare le note di rilascio per eventuali modifiche all'API e a informare altri fornitori di servizi, se necessario.
Piattaforma API Eventi Campus
È possibile accedere alla piattaforma API tramiteIhre-Campus-Events-Domain.de/api. Qui è possibile:
- Visualizzare i vari endpoint (interfacce) dell'API.
- Esplorare le strutture di dati.
- Effettuare richieste di prova e recuperare i risultati.
A tal fine è necessario un utente amministratore. In alternativa, la chiave API può essere aggiunta all'URL, ad esempio: https://Ihre-Campus-Events-Domain.de/api?apiKey=00000000-0000000000000000-00000000(a questo punto è stato inserito "0" come esempio invece di una chiave API corretta). Le ulteriori fasi di autenticazione devono comunque essere eseguite.
Facendo clic sul pulsante "Autorizza", è possibile inserire la propria chiave API e definire l'autorizzazione per le richieste (ad esempio, tramite intestazione o URL). Si consiglia il metodo tramite "apiKeyHeader (apiKey)".
Richieste API
Una volta autorizzata la chiave API, è possibile iniziare a fare richieste, ad esempio per recuperare eventi o dati dei partecipanti. Fare clic su "Prova" per generare una richiesta.
La risposta viene emessa di default in formato JSON, facile da leggere e da elaborare con i programmi.
Esempio di richiesta (Curl)
curl -X 'GET' \
'https://[il tuo dominio]/api/events?page=1' \
-H 'accept: application/ld+json' \
-H 'X-API-KEY: XXXXXXXX-XXXXXXXXXXXXXXXXXXXX-XXXXXXXXXX'
URL di richiesta
[il vostro dominio]/api/events?page=1Risposta
{
"@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",
"sottotitolo": "Simposio presso il Centro Studi Internazionale/Centro Linguistico",
"nome": "Ripensare l'internazionalizzazione?",
"modifiedAtRecursive": "2024-07-10T00:08:52+02:00",
"@urls": {
"directRegistrationUrl": null,
"eventUrl": "https://[yourdomain]/evento/internazionalizzazione".
}
}
]
}