Siirry pääsisältöön

Teachworks-sovellusliittymä

Tekijä: Teachworks Support

Teachworks API on sovellusohjelmointirajapinta, jonka avulla voit käyttää Teachworks-tililläsi olevia tietoja mukautettujen integraatioiden ja ohjelmistojen kehittämiseksi.

HUOMAUTUS: API-käyttöoikeus on saatavilla vain yrityksille, joilla on "Kasvu"- ja "Premium"-tilaukset.

API:n käyttöönotto

  1. Napsauta "Tili" ja sitten "Integraatiot ja lisäosat".

  2. Käytä yläreunassa olevaa "Haku"-kenttää ja kirjoita "API".

  3. Ota API käyttöön kytkemällä kytkin asentoon "Päällä".

Käyttö

Kun olet ottanut API:n käyttöön, voit napsauttaa "Asetukset"-linkkiä. Voit luoda Teachworks API -tunnuksesi napsauttamalla "Luo API-tunnus" -painiketta.

Käytät tätä avainta kirjautuaksesi tilillesi API:n kautta. Suojaa tämä avain salasanalla äläkä lisää sitä julkisille verkkosivuille (sitä tulisi käyttää palvelinpuolella julkisilla verkkosivuilla).

Voit myös napsauttaa "Luo hiekkalaatikkotili" -painiketta, jos haluat luoda hiekkalaatikkotilin API-integraation testaamista varten ennen sen yhdistämistä yrityksesi live-tiliin.

API-dokumentaatio

Löydät API-rajapintamme dokumentaation täältä: Teachworks API -dokumentaatio. Lisäämme API:in uusia päätepisteitä, joiden avulla voit käyttää erityyppisiä tietoja ja hallita tietueita.

Jos olet kiinnostunut päätepisteestä, jota ei ole tällä hetkellä saatavilla, ota meihin yhteyttä osoitteessa support@teachworks.com , niin selvitämme sen lisäämistä.

Vastasiko tämä kysymykseesi?