Teachworks API är ett applikationsprogrammeringsgränssnitt som låter dig komma åt data i ditt Teachworks-konto för att utveckla anpassade integrationer och programvara.
OBS: API-åtkomst är endast tillgänglig för företag med prenumerationerna "Growth" och "Premium".
Aktivera API:et
Klicka på "Konto" och sedan på "Integrationer och tillägg".
Använd sökfältet högst upp och ange "API".
Växla reglaget till "På" för att aktivera API:et.
Användande
När du har aktiverat API:et kan du klicka på länken "Inställningar". Du kan generera din Teachworks API-token genom att klicka på knappen "Generera API-token".
Du kommer att använda den här nyckeln för att komma åt ditt konto via API:et. Skydda nyckeln som ett lösenord och inkludera den inte på några offentliga webbsidor (den bör användas på serversidan för offentliga webbsidor).
Du kan också klicka på knappen "Skapa sandboxkonto" om du vill skapa ett sandboxkonto för att testa din API-integration innan du ansluter den till ditt företags aktiva konto.
API-dokumentation
Du hittar dokumentationen för vårt API här: Teachworks API Docs. Vi kommer att lägga till ytterligare slutpunkter till API:et för att komma åt ytterligare datatyper och hantera poster.
Om du är intresserad av en slutpunkt som inte är tillgänglig för närvarande, vänligen kontakta oss på support@teachworks.com så undersöker vi möjligheten att lägga till den.