Cyql API documentatie

Gewijzigd op Di, 5 Mei om 12:21 PM

Technische documentatie voor ontwikkelaars

Met de Cyql API kun je externe applicaties veilig laten communiceren met Cyql. Denk hierbij aan koppelingen met een website, dashboard of andere systemen.

Via een API-sleutel (API key) krijgt een externe applicatie toegang tot data binnen jouw club, afhankelijk van de beschikbare endpoints en de limieten van jullie abonnement.

Voor de technische documentatie en beschikbare endpoints:

https://api.cyql.app/api/docs/

In dit artikel:

Wat is een API-sleutel?
Wie kan API-sleutels beheren?
Een nieuwe API-sleutel aanmaken
Een API-sleutel kopiëren
API-limieten begrijpen
API-sleutel bewerken of verwijderen
Belangrijke beveiligingstips

Wat is een API-sleutel?

Een API-sleutel is een beveiligde toegangscode waarmee een externe applicatie verbinding kan maken met Cyql. Bijvoorbeeld: een club kan een API-sleutel gebruiken om ritten of clubdata te tonen op een externe website. Behandel een API-sleutel altijd als een wachtwoord. Iedereen met toegang tot de sleutel kan mogelijk data van jouw club ophalen.

Wie kan API-sleutels beheren?

API-sleutels kunnen worden beheerd door gebruikers met toegang tot het clubdashboard en de juiste rechten binnen de clubinstellingen.

Een nieuwe API-sleutel aanmaken

Stap 1

Open het Cyql dashboard.

Stap 2

Ga in het linkermenu naar Instellingen en klik op API.

Stap 3

Klik op de knop Nieuwe API-key.

Stap 4

Geef de API-sleutel een duidelijke naam.

Bijvoorbeeld:

Website koppeling
Clubwebsite API
Extern dashboard
Mobiele app integratie

Kies een naam waarmee je later direct herkent waar de sleutel voor wordt gebruikt.

Stap 5

Stel de maximale complexiteit in.

De complexiteit bepaalt hoeveel “zwaarte” aan API-verzoeken deze sleutel mag gebruiken. Hoe hoger de waarde, hoe zwaarder de queries mogen zijn en hoe meer capaciteit er wordt verbruikt.

Stap 6

Klik op Opslaan.

De API-sleutel wordt nu aangemaakt.

Een API-sleutel kopiëren

Na het aanmaken verschijnt een venster met de details van de API-sleutel. Klik op de kopieerknop om de sleutel te kopiëren (leeg gelaten in het screenshot)

Gebruik deze sleutel in je externe applicatie om verbinding te maken met Cyql. Let op: plaats de API-sleutel nooit in publieke code (zoals frontend JavaScript) waar bezoekers deze kunnen zien.

API-limieten begrijpen

De mogelijkheden van de API hangen af van het abonnement van jouw club. Denk hierbij aan:

Aantal API-sleutels
Maximale depth
Maximale complexiteit per request
Wekelijkse complexiteit

Op de API-pagina zie je het gebruik en de limieten per sleutel.

Wanneer een externe applicatie requests doet, loopt het verbruik op binnen deze limieten.

API-sleutel bewerken of verwijderen

Op de API-pagina zie je per API-sleutel actieknoppen.

Gebruik het bewerk-icoon om naam of complexiteit aan te passen
Gebruik het verwijder-icoon om de sleutel te verwijderen

Na verwijderen werkt de API-sleutel direct niet meer en verliezen gekoppelde applicaties de toegang.

Belangrijke beveiligingstips

Ga zorgvuldig om met API-sleutels.

Niet doen:

API-sleutels delen zonder controle
Sleutels in publieke repositories plaatsen
Eén sleutel gebruiken voor meerdere integraties
Ongebruikte sleutels laten bestaan

Wel doen:

Duidelijke namen gebruiken
Ongebruikte sleutels verwijderen
Per integratie een aparte sleutel aanmaken
Sleutels veilig opslaan in je backend

API documentatie

Voor developers is de volledige technische documentatie beschikbaar via:

https://api.cyql.app/api/docs/