De Teachworks API is een applicatieprogrammeersinterface waarmee u toegang krijgt tot de gegevens in uw Teachworks-account om aangepaste integraties en software te ontwikkelen.
LET OP: API-toegang is alleen beschikbaar voor bedrijven met een "Growth"- of "Premium"-abonnement.
De API inschakelen
Klik op 'Account' en vervolgens op 'Integraties en add-ons'.
Gebruik het zoekveld bovenaan en voer 'API' in.
Zet de schakelaar op "Aan" om de API in te schakelen.
Gebruik
Nadat je de API hebt ingeschakeld, kun je op de link 'Instellingen' klikken. Je kunt je Teachworks API-token genereren door op de knop 'API-token genereren' te klikken.
Met deze sleutel krijgt u via de API toegang tot uw account. Bescherm deze sleutel als een wachtwoord en neem hem niet op in openbare webpagina's (deze sleutel dient aan de serverzijde te worden gebruikt voor openbare webpagina's).
Je kunt ook op de knop 'Sandbox-account aanmaken' klikken als je een sandbox-account wilt aanmaken om je API-integratie te testen voordat je deze koppelt aan het live-account van je bedrijf.
API-documentatie
De documentatie voor onze API vindt u hier: Teachworks API-documentatie. We zullen extra eindpunten aan de API toevoegen voor toegang tot andere soorten gegevens en het beheren van records.
Als u geïnteresseerd bent in een eindpunt dat momenteel niet beschikbaar is, neem dan contact met ons op via support@teachworks.com en we zullen onderzoeken of we het kunnen toevoegen.