Maxtech Public API : Maxtech Pro-järjestelmän avoin rajapinta
Ojala, Annika (2020)
2020
All rights reserved. This publication is copyrighted. You may download, display and print it for Your own personal use. Commercial use is prohibited.
Julkaisun pysyvä osoite on
https://urn.fi/URN:NBN:fi:amk-2020093020847
https://urn.fi/URN:NBN:fi:amk-2020093020847
Tiivistelmä
Opinnäytetyö perustuu Max Technologies Oy:n toimeksiantoon, jossa aiheena oli suunnitella ja osittain toteuttaa helposti laajennettavissa oleva Maxtech Pro -järjestelmän avoin rajapinta ja rajapinnalle dokumentaatio. Rajapinnan kautta järjestelmän dataa voidaan hyödyntää sisäisessä tai kolmannen osapuolen ohjelmistokehityksessä.
Työssä rajapintaan kehitettiin REST-arkkitehtuuria käyttäen tietojen lukutoiminnallisuus sekä organisaatiokohtainen autentikointi, jolla todennetaan rajapinnan käyttäjä ja rajataan tietoihin pääsy. Lisäksi rajapinnalle tehtiin interaktiivinen dokumentaatio OpenAPI-määrittelyä ja ReDoc-dokumentaatiotyökalua käyttäen.
Tuloksena syntyi toimivat rajapinta- ja dokumentaatiopohjat jatkokehitystä varten. Ennen rajapinnan avaamista asiakkaille rajapintaan kehitetään oleellisimmat osat valmiiksi.
Työssä rajapintaan kehitettiin REST-arkkitehtuuria käyttäen tietojen lukutoiminnallisuus sekä organisaatiokohtainen autentikointi, jolla todennetaan rajapinnan käyttäjä ja rajataan tietoihin pääsy. Lisäksi rajapinnalle tehtiin interaktiivinen dokumentaatio OpenAPI-määrittelyä ja ReDoc-dokumentaatiotyökalua käyttäen.
Tuloksena syntyi toimivat rajapinta- ja dokumentaatiopohjat jatkokehitystä varten. Ennen rajapinnan avaamista asiakkaille rajapintaan kehitetään oleellisimmat osat valmiiksi.