Rajapinnat

Zeus
,
1

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:

1165×808 31.3 KB

Kun tunnistautumispyyntö onnistuu, se palauttaa valtuutusavaimen (token, pitkä merkkijono), joka on aina liitettävä headers-osioon kun tietoja kysellään. (Authorization: Bearer VALTUUTUSAVAIN)

1163×1012 59.5 KB

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: Advanced REST client - Chrome Web Store

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

{GET /v1/api/reports/vehicles}

{GET /v1/api/reports/vehicles/{encryptedId}

{GET /v1/api/reports/companies}

{GET /v1/api/reports/invoices/sales/openinvoices}

{GET /v1/api/reports/invoices/sales/after}

{GET /v1/api/reports/invoices/sales/{encryptedId}

{GET /v1/api/reports/invoices/purchases/after}

{GET /v1/api/reports/invoices/purchases/{encryptedId}

{GET /v1/api/reports/worksites}

{GET /v1/api/reports/costcenters}

{GET /v1/api/reports/customers}

{GET /v1/api/reports/customers/{encryptedId}

{GET /v1/api/reports/priceclasses}

{GET /v1/api/reports/customer-groups}

{GET /v1/api/reports/subcontractors}

{GET /v1/api/reports/subcontractors/{encryptedId}

{GET /v1/api/reports/offices}

{GET /v1/api/reports/singleorders/{encryptedId}

{GET /v1/api/reports/singleorders/after}

Esimerkki: asiakaskysely:

1234×1028 95.9 KB