Menu
Bisnoden rajapinnat

Käyttäjän tunnistautuminen ja rajapintojen käyttäminen

Tämän pikaohjeen avulla ymmärrät miten Bisnoden tunnistautumisrajapinta toimii ja miten varsinaisia sisältörajapintoja käytetään. Aloita kohdasta 1 ja siirry sen jälkeen vaiheeseen 2.


1) Tiketti -rajapinta

Rajapinta toteuttaa HTTP Basic -tunnistautumisen. Jos tunnistauminen onnistuu niin rajapinta palauttaa statuskoodin 200 (success) ja ticket -muuttujan JSON-muodossa. Jos tunnistautumistietoja ei ole annettu, ne ovat virheelliset tai ne eivät ole voimassa niin rajapinta palauttaa HTTP Basic -spesifikaation mukaisesti statuskoodi 401 (invalid) ja virheviestin JSON-muodossa.

Huom! Jotta voit käyttää tiketti -rajapintaa sinulla tulee olla tiedossa Bisnoden myöntämät ympäristökohtaiset (tuotanto- ja testiympäristö) tunnistautumistiedot:
· Käyttäjätunnus
· Salasana

Osoitteet / URL:t

· https://api.bisnode.fi/permission/v1/ticket - Tuotantoympäristö
· https://api-test.bisnode.fi/permission/v1/ticket - Testiympäristö

Huom! Yhteydet tuotanto- ja testiympäristöihin tulee toteuttaa aina salattuina https-muodossa.

Tunnistautuminen onnistuu - 200

Tunnistautumistietoja: ei annettu, ovat virheelliset tai eivät voimassa - 401


2) Kaupparekisteriote -rajapinta

Rajapinta palauttaa kaupparekisteriotteen PDF -muodossa. Jos käyttöoikeudet (yleiset ja rajapintakohtaiset) ovat kunnossa ja pyynnössä on pakolliset parametrit määritelty oikein niin pyyntö onnistuu. Jos tiketti ei ole voimassa tai tiketillä ei ole oikeutta käyttää rajapintaa saadaan vastaus statuskoodilla 200 ja virheviesti JSON-muodossa.

Huom! Jotta voit käyttää kaupparekisteriote -rajapintaa sinulla tulee olla tiedossa voimassaoleva tiketti (katso vaihe 1). Lisäksi käyttäjätunnukselle tulee olla määritelty ympäristökohtaiset (tuotanto- ja testiympäristö) käyttöoikeudet kaupparekisteriote -rajapintaan.

Osoitteet / URL:t

· https://api.bisnode.fi/yritykset/v1/TradeRegisterEntryInfo - Tuotantoympäristö
· https://test.bisnode.fi/yritykset/v1/TradeRegisterEntryInfo - Testiympäristö

Pyynnössä käytettävissä olevat pakolliset parametrit:
· businessId = y-tunnus
· registrationNumber = kaupparekisteritunnus

Jos toinen noista on tiedossa niin sen perusteella voidaan kaupparekisteriote esittää. Jos käytetään molempia samanaikaisesti niin businessId -parametri otetaan vain huomioon.

Huom! Yhteydet tuotanto- ja testiympäristöihin tulee toteuttaa aina salattuina https-muodossa.

Onnistunut pyyntö

Epäonnistunut pyyntö


Usein kysytyt kysymykset

Miten tikettiä oikein käytetään?
Rajapinta pyyntöjen (request) yhteydessä tiketti -arvo tulee lähettää header -elmentissä (ticket -parametrina) pyynnön mukana. Jos tiketti on voimassa niin pyyntö onnistuu (vastaus 200), muuten se epäonnistuu (vastaus 200 ja virheviesti JSON muodossa).

Miten pitkään tiketti on voimassa?
Tiketti on voimassa 20 minuuttia, jonka jälkeen se vanhenee automaattisesti.

Miten uusi tiketti hankitaan?
Tiketti -rajapinta palauttaa uuden tiketin.

Tulosta

Läs mer om våra tjänster på www.bisnode.com Bisnode