Integraties

Lees hoe je gebruik kunt maken van integraties met derde partijen

Integraties

Lees hoe je gebruik kunt maken van integraties met derde partijen

De Atleta API gebruiken

De Atleta API gebruiken
Om gebruik te maken van de GraphQL API van Atleta heb je een toegangstoken nodig. Dit toegangstoken kan je verkrijgen door een app te koppelen aan je project.

Een app koppelen
Om een app te koppelen ga je naar de instellingen. Klik in de navigatiebalk op de naam van je organisatie, kies Instellingen en ga daarna naar het tabje API. Hier vind je een overzicht van alle gebruikers en apps die toegang hebben tot je project.

Klik bij de sectie ‘Apps’ op ‘App toevoegen’. Vul hier een naam in voor de koppeling. Deze naam wordt gebruikt om te tonen in de lijst van gekoppelde apps, zodat je deze later kan terugvinden en eventueel ontkoppelen. Klik op ‘App toevoegen’ om de app op te slaan.

Hierna wordt de API token eenmalig getoond. Sla hem op op een veilige locatie (behandel dit token het alsof het een wachtwoord is). Zodra je op ‘OK’ klikt kunnen we je toegangstoken niet meer terughalen.

Gebruikmaken van de GraphQL API
Atleta biedt een GraphQL API aan op het endpoint https://atleta.cc/api/graphql
Een deel van deze GraphQL API is publiek toegankelijk. Om toegang te krijgen tot data van jouw project, is een toegangstoken nodig. Deze kan je meesturen in de volgende HTTP header, waarbij je $token vervangt door jouw token:

Authorization: Bearer $token

Onze GraphQL API ondersteunt zogeheten ‘introspection’, waarmee je kan zien welke velden er beschikbaar zijn. We verwijzen je hiervoor graag door naar algemene documentatie over hoe GraphQL werkt.

De belangrijkste ingang in onze API is de ‘project’ property op de Query type. Hiervoor is een Project ID nodig, die je kan vinden in de URL van het dashboard waarop je je app hebt gekoppeld: de vier tekens na atleta.cc/b/ zijn die van jouw project.

query {
	project(id: "TEST") {
        organisation_name
	}
}


Een voorbeeld-query die de naam van project TEST ophaalt ziet er als volgt uit:

POST /api/graphql HTTP/1.1
Authorization: Bearer $token
Content-Type: application/json; charset=utf-8
Host: atleta.cc

{
	"query": "query { project(id:\\"TEST\\") { organisation_name } }",
	"variables": {}
}