Rajapinnat
Rajapintakäyttäjä ja valtuutusavain
Rajapintojen käyttö vaatii valtuutusavaimen, jonka avulla varmistetaan, että rajapintaan lähetetyt pyynnöt ovat sallittuja.
Valtuutusavain vaatii sen, että LogiPlanissa on luotuna rajapintakäyttäjä:
- Rooli, kun tarvitaan verkkokaupalle käyttäjä: “Verkkokaupparajapinnan käyttöoikeus”
- Rooli, kun tarvitaan muu rajapintakäyttäjä: “Käyttöoikeus ulkoiseen rajapintaan”
Valtuutusavain haetaan seuraavalla tavalla:
- RequestURL-kohtaan kirjoitetaan vastaanottajan verkko-osoite, joka on muotoa https://ASIAKASYMPÄRISTÖ.logiplan.fi/ui/api/v1/authenticate
- Laitetaan headers-osioon seuraavat tiedot:
- accept: application/json, text/plain, /
- content-type: application/json
- body-osioon laitetaan käyttäjätunnus ja salasana (kts.kuva)
Jos tunnus tai salasana on väärin, niin tunnistautumispyyntö palauttaa “Bad Credentials” -viestin:
Kun tunnistautumispyyntö onnistuu, se palauttaa valtuutusavaimen (token, pitkä merkkijono), joka on aina liitettävä headers-osioon kun tietoja kysellään. (Authorization: Bearer VALTUUTUSAVAIN)
Tilausrajapinta
Zeukseen voidaan lähettää tilauksia ulkoisesta järjestelmä. Viestin formaatti löytyy rajapintakuvauksesta.
Huomioita
- Rajapinta perustaa aina uuden asiakkaan, jos viestissä saadulla asiakasnimellä ei löydetä mitään.
- Tämä tulee tapahtumaa aina, kun nimi muuttuu tai siitä tulee erilaisia muunnelmia. Esim. “Allin Oy”, "Allin “AllinOy”…
Rajapinta päättellee asiakaspäättelyprosessi:
-
Ensiksi haetaan asiakkaan ns. päänimen avulla.
-
Jos asiakasta ei löydetä niin käytetään lisänimeä
-
Jos asiakasta ei vieläkään löydetä niin luodaan uusi
-
Jos luotiin uusi asiakas niin tehdään järjestelmäilmoitus.
Raporttirajapinta
Löytyy osoitteesta https://ASIAKASYMPÄRISTÖ.logiplan.fi/logiplan/ui/api/swagger-ui/#/Data
Huom: jos haet rajapinnan kautta kaikki mahdolliset tiedot niin tämä hidastaa järjestelmän käyttöä. Lisäksi kannattaa huomioida se, että tietojen hakeminen on maksullista (Amazon ottaa siirrettävästä tiedosta korvausta. 2020-08-13: 0,09€ / Gigatavu). Summa on pieni, mutta jos kyselyjä tekevässä järjestelmässä on virhe niin summa voi nopeasti nousta isoksi.
Esimerkeissä käytetään ARC-ohjelmaa, mutta myös muiden ohjelmien avulla tietoja kyseleminen on mahdollista (mm. curl, postman…) ARC ohjelman voi asentaa Chrome-selaimeen osoitteesta: https://chrome.google.com/webstore/detail/advanced-rest-client/hgmloofddffdnphfgcellkdfbfbjeloo
Rajapinnan normaali käyttö tapahtuu yleensä raportointijärjestelmän toimesta.
Rajapintakyselyt palauttavat aina JSON (Javascript Object Notation: JSON - Wikipedia)-muotoista tietoa.
20.2.1 Rajapintalistaus
Ajantasaiset rajapintamäärittelyt löydät Zeuksen oikeasta yläreunasta.
Esimerkki: asiakaskysely:
