Verkko-ohjelmointirajapinta yritykselle
Lankinen, Jimi (2019)
2019
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-2019112722930
https://urn.fi/URN:NBN:fi:amk-2019112722930
Tiivistelmä
Insinöörityönä tehtiin asiakasyritykselle verkko-ohjelmointirajapinta, jonka avulla voidaan automatisoida tilausten käsittelyä ja tekemistä. Asiakasyritys on betonin ja haitta-aineiden analysointiin erikoistunut laboratorio. Se tarjoaa monia eri tutkimuksia näytteille. Esimerkiksi tutkitaan näytteiden asbesti- tai lyijypitoisuuksia. Tavoitteena oli saada toimiva rajapinta asiakasyrityksen käyttöön.
Verkko-ohjelmointirajapinnan kehityksessä käytettiin C#-ohjelmointikieltä ja ASP.NET-ohjelmistokehystä. Nämä tekniikat valittiin, koska niistä on aikaisempaa kokemusta ja ne tarjoavat hyvän tuen Microsoftin muihin tekniikoihin, kuten Azuren pilvipalveluihin julkaise-misen yhdellä klikkauksella. Verkko-ohjelmointirajapinta käytti SQL-tietokantaa, joka oli jo aiemmin ollut käytössä yrityksen MS Access -sovelluksessa. SQL-tietokannan taulut määrit-tivät rajapinnan tarjoamat resurssit. SQL-tietokantaan tehtiin pieniä muutoksia projektin ede-tessä. Esimerkiksi lisättiin kenttiä tauluihin. Muita käytettyjä tekniikoita oli esimerkiksi Entity Framework, jonka avulla voidaan mallintaa SQL-tietokanta C#-ohjelmointikielen luokiksi. Entity Frameworkin mallintamia luokkia voidaan käyttää ohjelmakoodissa.
Toimivan rajapinnan tekemiseen meni noin sata työtuntia. Verkko-ohjelmointirajapinta nou-datti suurimmaksi osaksi REST-arkkitehtuuria, mutta sisälsi kuitenkin poikkeuksia. Esimer-kiksi rajapinnan kaikki päätepisteet eivät tarjonneet CRUD-operaatioita. Rajapinta tarjoaa päätepisteet, joiden avulla projekteja ja projektinäytteitä voidaan lisätä. Näiden lisäksi raja-pinta tarjoaa päätepisteen, jonka avulla käyttäjä tunnistetaan ja käyttäjälle palautetaan API-KEY, jonka avulla käyttäjän seuraavat pyynnöt tunnistetaan. Päätepisteiden ominaisuuksia määriteltiin erilaisten attribuuttien avulla. Esimerkiksi määritettiin päätepisteen käyttävä http-metodi ja URL-osoite.
Insinöörityön lopputuloksena saatiin toimiva verkko-ohjelmointirajapinta yritykselle. Verkko-ohjelmointirajapinnan avulla automatisoitiin tilausten käsittelyä ja tekemistä. Tämä mahdol-listaa useampien tilauksien käsittelyn kuin aikaisemmin. Rajapinta mahdollistaa myös kulje-tusyrityksen rajapinnan avulla kuljetuksien tilaamisen tutkittaville näytteille. Tämä helpottaa tilausten tekemistä asiakkaalle. Asiakasyritys ja kuljetus molemmat hyötyvät tästä.
Verkko-ohjelmointirajapinnan kehityksessä käytettiin C#-ohjelmointikieltä ja ASP.NET-ohjelmistokehystä. Nämä tekniikat valittiin, koska niistä on aikaisempaa kokemusta ja ne tarjoavat hyvän tuen Microsoftin muihin tekniikoihin, kuten Azuren pilvipalveluihin julkaise-misen yhdellä klikkauksella. Verkko-ohjelmointirajapinta käytti SQL-tietokantaa, joka oli jo aiemmin ollut käytössä yrityksen MS Access -sovelluksessa. SQL-tietokannan taulut määrit-tivät rajapinnan tarjoamat resurssit. SQL-tietokantaan tehtiin pieniä muutoksia projektin ede-tessä. Esimerkiksi lisättiin kenttiä tauluihin. Muita käytettyjä tekniikoita oli esimerkiksi Entity Framework, jonka avulla voidaan mallintaa SQL-tietokanta C#-ohjelmointikielen luokiksi. Entity Frameworkin mallintamia luokkia voidaan käyttää ohjelmakoodissa.
Toimivan rajapinnan tekemiseen meni noin sata työtuntia. Verkko-ohjelmointirajapinta nou-datti suurimmaksi osaksi REST-arkkitehtuuria, mutta sisälsi kuitenkin poikkeuksia. Esimer-kiksi rajapinnan kaikki päätepisteet eivät tarjonneet CRUD-operaatioita. Rajapinta tarjoaa päätepisteet, joiden avulla projekteja ja projektinäytteitä voidaan lisätä. Näiden lisäksi raja-pinta tarjoaa päätepisteen, jonka avulla käyttäjä tunnistetaan ja käyttäjälle palautetaan API-KEY, jonka avulla käyttäjän seuraavat pyynnöt tunnistetaan. Päätepisteiden ominaisuuksia määriteltiin erilaisten attribuuttien avulla. Esimerkiksi määritettiin päätepisteen käyttävä http-metodi ja URL-osoite.
Insinöörityön lopputuloksena saatiin toimiva verkko-ohjelmointirajapinta yritykselle. Verkko-ohjelmointirajapinnan avulla automatisoitiin tilausten käsittelyä ja tekemistä. Tämä mahdol-listaa useampien tilauksien käsittelyn kuin aikaisemmin. Rajapinta mahdollistaa myös kulje-tusyrityksen rajapinnan avulla kuljetuksien tilaamisen tutkittaville näytteille. Tämä helpottaa tilausten tekemistä asiakkaalle. Asiakasyritys ja kuljetus molemmat hyötyvät tästä.