Verohallinnon nimissä on lähetetty huijausviestejä. Lue lisää huijauksista.

Miten rajapinnat otetaan käyttöön

Tällä sivulla on esitetty Vero API ‑rajapintojen käyttöönoton vaiheet. Noudata vaiheita ja niihin liittyviä ohjeita esitetyssä järjestyksessä varmistaaksesi onnistuneen käyttöönoton.

1. Tutustu Vero API -rajapintapalveluun

Lue yleiset ja tekniset ohjeet ennen rajapintaintegraation kehittämistä tai testauksen aloittamista.

2. Kokeile Hiekkalaatikossa

Hiekkalaatikossa kehittäjät voivat tutustua Vero API -rajapintapalvelun nykyisiin ja tuleviin rajapintoihin.

  • Rajapintojen URL: api-sandbox.vero.fi
  • Hiekkalaatikkoon rekisteröidytään erikseen, jolloin käyttäjä saa vain hiekkalaatikossa toimivan API-avaimen (Subscription key).

Tutustu ja kokeile API-palveluita hiekkalaatikossa

3. Ohjelmiston rekisteröinti API-portaalissa ja API-avain

Ohjelmistojen rekisteröinnin tavoitteena on parantaa rajapintojen käyttökokemusta ja integraatioiden laatua määrämuotoisen käyttöönottomenettelyn ja kohdennetun ohjauksen avulla.

  • Ohjelmisto rekisteröidään portaalissa, jonka jälkeen käyttäjä saa API-avaimen, jota tarvitaan rajapintojen tuotantokäytössä.
  • Rekisteröinti portaalissa on suositeltua tehdä jo ennen testaamisen aloittamista.

Ohjelmiston rekisteröinti ja hyväksyntämenettely - vero.fi

4. Rajapintojen testaus ja testivarmenteen hakeminen

Testauksella varmistetaan toimiva integraatio ohjelmiston ja Verohallinnon välillä.

  • Rajapintoja käyttävällä organisaatiolla pitää olla voimassa oleva Vero API rajapintasopimus.
    • Testauksen rajapintahakemus tehdään Verohallinnon varmennepalvelun testivarmenteet-osiossa.
    • Varmennepalvelusta voi myös tarkistaa, onko testauksen rajapintasopimus voimassa.
  • Tarvitset testivarmenteen Varmennepalvelusta.
  • API-portaalista saatu API-avain annetaan Vero-SoftwareKey headerissa.
  • Rajapintojen dokumentaatiot ja testiympäristön osoitteet löydät Vero API-portaalista (URL Testi)

Vero API - Toteuta ja testaa testiympäristössä - vero.fi

5. Hyväksymistestaus tuotantokäyttöä varten ja tuotantovarmenne

Rajapintojen tuotantokäyttö edellyttää ohjelmistojen hyväksymistestausta. Ohjelmiston hyväksymistestaus tehdään itsepalveluna API-portaalissa. 

  • Hyväksymistestausmenettely on eri asia, kuin varsinainen integraation toimivuuden testaaminen. Hyväksymistestaus tehdään, kun ohjelmisto on kehitetty ja testattu kokonaan.
  • Rajapintoja käyttävällä organisaatiolla pitää olla voimassa oleva Vero API rajapintasopimus.
    • Tuotannon rajapintahakemus tehdään Verohallinnon varmennepalvelun tuotantovarmenteet-osiossa.
    • Varmennepalvelusta voi myös tarkistaa, onko tuotannon rajapintasopimus voimassa.
  • Tarvitset tuotantovarmenteen Varmennepalvelusta.
  • API-avain annetaan Vero-SoftwareKey headerissa.
  • Hyväksymistestauksen osoitteet löydät Vero API-portaalista (URL Integraation verifiointi)

Ohjelmiston rekisteröinti ja hyväksyntämenettely - vero.fi

6. Rajapintojen tuotantokäyttö

Rajapintojen tuotantokäyttöä varten käyttäjän tulee suorittaa ja huomioida alla olevat asiat.

  • Sovellus on rekisteröity API-portaaliin ja hyväksymistestaus on suoritettu.
  • Rajapintoja käyttävällä organisaatiolla pitää olla voimassa oleva Vero API rajapintasopimus.
    • Tuotannon rajapintahakemus tehdään Verohallinnon varmennepalvelun tuotantovarmenteet-osiossa.
    • Varmennepalvelusta voi myös tarkistaa, onko tuotannon rajapintasopimus voimassa.
  • Rajapintojen käyttäjä on hakenut tuotantovarmenteen Varmennepalvelusta.
  • Ohjelmisto asettaa API-avaimen Vero-SoftwareKey headeriin.
  • Rajapintojen tuotanto-osoitteet löydät Vero API-portaalista (URL Tuotanto)

Vero API - Siirry tuotantoon - vero.fi


Sivu on viimeksi päivitetty 18.6.2025