Integracija

Wise Timetable REST API

Viską, ką Wise Timetable skelbia, galima skaityti kaip JSON per HTTPS — Jūsų portalui, virtualiai mokymosi aplinkai, Jūsų pačių programėlei, informaciniam ekranui ar ataskaitų įrankiui. Vadovas yra viešas, todėl Jūsų kūrėjai gali įvertinti integraciją prieš kam nors ką nors pasirašant.

Užsisakykite internetinę demonstraciją Atsisiųsti nemokamą bandomąją versiją

API v2, JSON per HTTPS
Pilnas vadovas be registracijos
ETag spartinimas, 304, kai nieko nepasikeitė

Galite ją apžiūrėti dabar

Paslaugos aprašui nereikia prisijungimo duomenų, todėl pirmasis kūrėjo klausimas atsakomas viena eilute.

GET https://wise-tt.com/api/v2/meta grąžina paslaugos pavadinimą, versiją ir galinių taškų, kuriuos serveris šiuo metu teikia, sąrašą. Jokio rakto, jokios paskyros, jokio pardavimo skambučio — atidarykite naršyklėje. Tai taip pat sąžiningas būdas sužinoti apie viską, kas pridėta po paskutinio vadovo peržiūrėjimo.

Integracijos vadovas paskelbtas pilnai, be registracijos, su kiekvieno galinio taško parametrais, realistišku atsakymo pavyzdžiu kiekvienam ir pilnais veikiančiais pavyzdžiais curl, Python, JavaScript ir C kalbomis. Skelbiame jį todėl, kad integracija, kuri popieriuje atrodo įmanoma, o paaiškėja, kad ne, yra daug brangesnis atradimas trečią mėnesį.

Duomenims skaityti reikia API paskyros, kurią išduodame mes ir kuri apribota mokyklomis, kurias ji gali skaityti. Ši dalis sąmoninga: tvarkaraštis nurodo, kas ką dėsto ir kurie studentai jį lanko.

Viena užklausa vienam rodiniui, o ne jų grandinė

GET /v2/schedule priima mokyklą, datų intervalą ir tai, ką sekate — grupes, dėstytoją, auditoriją, dalyką arba nieką visai mokyklai — ir grąžina kiekvieną intervalo įvykį su jau užpildytomis auditorijomis, dėstytojais, grupėmis ir šakomis, kartu su mokyklos atostogomis ir paskelbtų akademinių metų ribomis. Nereikia papildomų užklausų identifikatoriams paversti pavadinimais.

Išmatuota didžiausioje serverio mokykloje, viena savaitė yra apie 100 kB ir 75 ms. Intervalas ribojamas 400 dienų per užklausą, todėl blogiausias atvejis yra žinomas, o ne staigmena tą dieną, kai kas nors paprašo dešimtmečio.

Įvykių identifikatoriai pirmuoju simboliu nurodo savo rūšį: S suplanuotai paskaitai, R rezervacijai — egzaminui, auditorijos užsakymui, susitikimui, laboratorijos užsiėmimui.

Ką API pateikia

Tvarkaraščiai pagal studentų grupę, dėstytoją, auditoriją ar dalyką — arba visą mokyklą iš karto
Pilna vieno įvykio informacija, įskaitant programų, kursų, šakų ir grupių hierarchiją už kiekvienos jį lankančios grupės
Paskelbtų akademinių metų ribos, kad klientas galėtų neleisti naudotojui pereiti į savaites, kuriose negali būti duomenų
Atostogos, kad tuščia diena būtų skaitoma kaip atostogos, o ne kaip trūkstami duomenys
Pranešimai, priskirti mokyklai, grupei, dalykui ar dėstytojui, be pasikartojimų ir grąžinami kaip struktūrizuoti objektai
Programų, šakų, grupių, dėstytojų, auditorijų ir dalykų kodų sąrašai — identifikatoriai ir žymės, iš kurių sudaromas pasirinkimo sąrašas
Auditorijos talpa, auditorijos kodas ir mokyklos auditorijos pašto dėžutė, kur mokykla juos užpildė
Mokyklos skambučių tvarkaraštis, nes užsiėmimų trukmė ne visur vienoda
Mokyklos savaičių numeriai ir mokyklos pačios savaitės pavadinimas, kur jis yra — savaitės numeris šiame produkte nėra kalendorinių metų ISO savaitė, ir joks klientas niekada neturėtų jos skaičiuoti
Užsakymo tipai, kuriuos naudoja mokykla, ir auditorijos, kurias kiekvienas dėstytojas gali rezervuoti, klientui, siūlančiam ne tik skaityti, bet ir užsakyti
Ką kiekviena mokykla leidžia klientui siūlyti, kad naršymo pagal dėstytoją pasirinkimas būtų paslėptas ten, kur dėstytojų užimtumas laikomas konfidencialiu
Lankomumo sąrašai, kai įstaiga taiko lankomumą QR kodu — kiekvienos paskaitos sąrašas visas, pagal datas pirmam užpildymui, o po to tai, kas pasikeitė nuo paskutinės užklausos, studentų informacinei sistemai. Asmens duomenys apie studentus, todėl paskyra juos skaito tik su atskiru leidimu

Ir dalys, kurias galite rašyti

API daugiausia skirta skaitymui, ir kiekviena išimtis įvardyta. POST /v2/eventlinks prideda internetinio susitikimo nuorodą prie atskirų įvykių pagal jų pastovų identifikatorių — nuoroda išlieka kitą kartą iš naujo skelbiant iš stalinės programos, o tvarkaraščio sudarytojo įvesta nuoroda nugali įstumtą. POST /v2/student-registration leidžia studentų informacinei sistemai nurodyti, kurioms grupėms ir dalykų laikymams studentas priklauso. PUT /v2/lecturer-language nustato kalbą, kuria parašytas paties dėstytojo tvarkaraščio PDF, įstaigoms, dėstančioms daugiau nei viena kalba.

Kiekviena jų išjungta, nebent Jūsų paskyrai aiškiai leista ją naudoti, ir kiekviena pateikia rezultatus pagal elementą, o ne žlunga visa partija dėl vieno neteisingai įvesto dalyko kodo.

Auditorijų užsakymai, atliekami asmens, o ne paskyros

Užsakymas yra vienintelė API dalis, kuriai visai nereikia integracijos paskyros, ir priežastį verta pasakyti aiškiai: užsakymą padaro kažkas, o tvarkaraštis užfiksuoja, kas. Darbuotojas prisijungia savo naudotojo vardu ir slaptažodžiu, gauna raktą, nurodantį vieną mokyklą ir galiojantį aštuonias valandas, ir kuria, keičia bei trina užsakymus savo vardu — todėl paskelbtoje programėlėje sukompiliuoti prisijungimo duomenys niekada negali pasiekti šio paviršiaus.

Prieš ką nors rašant, klientas gali paklausti, ar šablonas laisvas. GET /v2/free-busy išskleidžia kas antrą antradienį nuo kovo iki gegužės, 08:00–10:00, auditorija B-004 į tikras datas ir pagal datą praneša, kas jau trukdo — ir kas tai yra: auditorija, dėstytojas ar grupė. Susikirtimas atmetamas pridedant susikertančias datas, o ne paprastu ne, kartu su artimiausiais pradžios laikais ir kitomis auditorijomis, kurios laisvos kiekvieną iš tų datų. Planuotojas, kuris tikrai nori, vis tiek gali užsakyti per susikirtimą, ir tai užfiksuojama kaip sąmoningas sprendimas, o ne slepiama.

Visas paviršius — asmens prijungimas, mokyklos užsakymo tipai, kiekvieno dėstytojo auditorijų baltasis sąrašas, prieinamumas ir užsakymo kūrimas, keitimas bei trynimas — yra vadovo 13 skyrius su praktiniu pavyzdžiu nuo prisijungimo iki užsakytos auditorijos.

Sukurta klientui, kuris reguliariai klausia

Kiekvienas atsakymas turi ETag. Pakartokite užklausą su If-None-Match ir nepasikeitęs tvarkaraštis atsako 304 be jokio turinio, o tai dažniausias atvejis fojė ekranui, atsinaujinančiam kas kelias minutes. Gerai besielgiantis klientas ramią dieną perduoda beveik nieko.

Prisijungimo duomenys vieną kartą iškeičiami į nešiklio raktą, galiojantį 24 valandas ir koduojantį mokyklas, kurias jis gali skaityti. Naršyklės programos palaikomos per aiškų kilmės leidžiamųjų sąrašą, o ne pakaitos simbolį — pasakykite, iš kurios kilmės teikiama Jūsų informacijos skydelis, ir ji bus pridėta.

Klaidos, kurios pasako, kas nutiko

Neteisingai įvestas mokyklos kodas, mokykla, kurios Jūsų paskyra negali skaityti, ir savaitė, kurioje tikrai nėra paskaitų, yra trys skirtingos situacijos, o integracija, rodanti tą patį pranešimą visoms trims, iššvaisto kieno nors popietę. Tai 400 unknown_school, 403 school_not_permitted ir visiškai įprastas 200 su tuščiu sąrašu.

Kiekviena klaida grąžina pastovų mašininiu būdu skaitomą klaidos kodą, sakinį anglų kalba ir dažnai užuominą. 500 turi nuorodos identifikatorių; pateikite jį ir tikslias žurnalo eilutes bus galima rasti iš karto.

Senesnis paviršius vis dar teikiamas ir vis dar užšaldytas

Įstaigoms, kurios integravosi su ankstesne API, v2 integracijos nesugadino. Senieji keliai vis dar teikiami ir sąmoningai užšaldyti, o v2 sąmoningai išlaiko senus laukų pavadinimus — todėl perėjimas prie v2 yra adreso, o ne skaitytuvo pakeitimas, o v2 pridedami laukai yra papildymai, o ne pakaitalai.

Visa politika vienu sakiniu: API, pagal kurią universitetas kuria, yra pažadas, o jo sulaužymas dėl laukų pavadinimų sutvarkymo nėra sutaupymas.

Atsisiųskite API vadovą

Pamatykite Wise Timetable su savo duomenimis

Užsisakykite 45 minučių internetinę prezentaciją. Pereisime per jūsų įstaigos planavimo problemą, parodysime, kaip Wise Timetable ją sprendžia, ir atsakysime į viską, ką jūsų komanda nori išbandyti.