Integraties
Lees hoe je gebruik kunt maken van integraties met derde partijen
De Atleta API gebruiken
Dit artikel is bedoeld voor ontwikkelaars van een applicatie. Als organisator kun je je project aan hun app koppelen via een link die door de makers van de app wordt verstrekt.
Om de Atleta GraphQL API te gebruiken, heb je een toegangstoken nodig. Je kunt dit toegangstoken verkrijgen door een app aan te maken in je project. Organisatoren kunnen hun projecten aan je app koppelen nadat je deze hebt aangemaakt, met behulp van je koppelingslink.
Een app aanmaken
Om een app aan te maken, ga je naar de projectinstellingen. Klik op de naam van je organisatie in de navigatiebalk, selecteer Instellingen en ga vervolgens naar het tabblad ‘API’. Hier vind je een overzicht van alle apps die binnen je project zijn aangemaakt.
Klik op de knop ‘App toevoegen’ en vul hier een naam voor de app in. Deze naam wordt aan organisatoren getoond op de pagina waar ze verbinding maken met je app. Je kunt ook de machtigingen selecteren die je app nodig heeft om te functioneren. Het is aan te raden om zo min mogelijk machtigingen aan te vragen.
Wanneer je de app opslaat, wordt het API-token eenmalig weergegeven. Bewaar het op een veilige locatie (behandel dit token alsof het een wachtwoord is). Zodra je op ‘OK’ klikt, kunnen we je toegangstoken niet meer opvragen.
Je app koppelen aan andere projecten
Om toegang te krijgen tot projecten van organisatoren waarmee je samenwerkt, kun je de koppelingslink delen. Hiervoor ga je naar het tabblad ‘Gekoppelde projecten’ op de app-detailpagina. Hier zie je een lijst met alle gekoppelde projecten, evenals de link om te delen met organisatoren. Als je net je account hebt aangemaakt, kan er een bericht verschijnen over het verifiëren van je project.
Je kunt je eigen connect-link bezoeken om te zien hoe deze eruitziet voor de andere organisatoren. Zij kunnen een project selecteren dat ze willen autoriseren voor je app en de rechten zien die je hebt aangevraagd. Nadat er een verbinding is gemaakt, verschijnt je app in het tabblad ‘Integraties’ van hun projectinstellingen. Hier kunnen ze de toegang intrekken als ze dat willen.
De GraphQL API gebruiken
Atleta biedt een GraphQL API aan via: https://atleta.cc/api/graphql
Een deel van deze GraphQL API is openbaar toegankelijk. Om toegang te krijgen tot gegevens uit je project is een toegangstoken vereist. Je kunt dit opnemen in de volgende HTTP-header, waarbij je $token vervangt door je token:
Een overzicht van alle beschikbare velden is te vinden op: https://docs.atleta.cc/graphql/reference/. Daarnaast ondersteunt de GraphQL API ‘introspectie’, waarmee je kunt zien welke velden beschikbaar zijn. We verwijzen je graag naar de algemene documentatie over hoe GraphQL werkt.
Het belangrijkste toegangspunt in onze API is de ‘project’-eigenschap van het Query-type. Hiervoor is een Project-ID nodig, die je kunt vinden in de URL van het dashboard waar je je app hebt gekoppeld: de vier tekens na atleta.cc/b/ zijn die van jouw project.
Een voorbeeldquery die de naam van project TEST ophaalt, ziet er als volgt uit:
