Huoltomerkintöjen automatisoinnin mahdollistaminen API-integraatiolla

Abstract

Opinnäytetyön tavoitteena oli suunnitella ja toteuttaa DNA Oyj:lle API-rajapinta, joka automatisoi huoltomerkintöjen siirron valvontajärjestelmästä tukiasemien huoltotietojärjestelmään. Ratkaisulla pyrittiin vähentämään manuaalista työtä, parantamaan tietojen luotettavuutta ja luomaan pohja tuleville integraatioille.

Rajapinta toteutettiin REST-arkkitehtuurin mukaisesti ja varustettiin OAuth 2.0-pohjaisella autentikoinnilla. Käyttäjäkohtaiset kutsut todennettiin Authorisation Code Flow -mallilla ja koneiden välinen (M2M) viestintä Client Credentials Flow -mallilla. M2M-oikeudet rajattiin roolien ja erillisen scope-pohjaisen tieto-kantarakenteen avulla. Lisäksi toteutettiin virheenkäsittelymekanismi, joka ohjaa epäonnistuneet tapahtumat automaattisesti sähköpostiin jatkokäsittelyä varten.

Testauksen perusteella rajapinta toimi luotettavasti ja vastasi sille asetettuihin tietoturva- ja suorituskykyvaatimuksiin. Tuloksena syntyi palvelu, joka vastaanottaa, validoi ja tallentaa huoltomerkinnät ilman manuaalisia työvaiheita.

Kehittämisehdotuksena suositellaan muun muassa graafisen hallintatyökalun kehittämistä scope-oikeuksien ylläpitoon sekä rajapintaintegraatiota valvontajärjestelmään. Ratkaisun odotetaan siirtyvän tuotantoon organisaation pilvisiirtymän edetessä.

The objective of this study was to design a secure and scalable interface that automates the transfer of maintenance entries from a network-monitoring system to an internal base-station information system. The manual data entry after each network alarm had caused delays and errors.

The solution was implemented as a REST API. User-initiated traffic was authenticated with the OAuth 2.0 Authorization Code Flow, while machine-to-machine traffic used the Client Credentials Flow. The role-based access was refined with a dedicated scope registry stored in an internal database. The incoming JSON payloads were validated and written to the target system; unsuccessful transactions triggered an automatic e-mail alert generated by a fallback mechanism.

The testing indicated that the API met the defined performance and security criteria. The maintenance entries are now recorded without manual steps, which is expected to shorten the processing time and improve data integrity.

Further work should include a graphical console for the scope management and direct integration of API functions into the monitoring user interface.