Miten rajapinnat otetaan käyttöön
Tälle sivulle on kerätty listaus Vero API -rajapintojen käyttöönoton vaiheista. Eri vaiheet ja niihin liittyvät ohjeet ovat listattu järjestykseen, jota on suositeltua noudattaa.
1. Tutustu Vero API -rajapintapalveluun
Yleisiin ja teknisiin ohjeisiin on suositeltavaa tutustua ennen rajapintaintegraation kehittämistä tai testauksen aloittamista.
- Yleiset ohjeet: Mitä rajapinnat ovat - vero.fi
- Tekniset ohjeet: Tekniset ohjeet - vero.fi
- Puolesta asiointi rajapinnoissa ja valtuudet: Puolesta asiointi - vero.fi
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).
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.
4. Rajapintojen testaus ja testivarmenteen hakeminen
Testauksella varmistetaan toimiva integraatio ohjelmiston ja Verohallinnon välillä.
- 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)
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.
- Tarvitset tuotantovarmenteen Varmennepalvelusta.
- API-avain annetaan Vero-SoftwareKey headerissa.
- Hyväksymistestauksen osoitteet löydät Vero API-portaalista (URL Integraation verifiointi)
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.
- 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)