Procountor API (Application Programming Interface) on ohjelmointirajapinta, jonka avulla on mahdollista tehdä ohjelmallisia kutsuja toisesta ohjelmistosta Procountoriin.
Yleistä
Procountor API -rajapintaa voidaan käyttää lisäarvoa tuottavien integraatioiden rakentamiseen sekä kaupallisten ohjelmistojen että yrityksen sisäisten järjestelmien ja Procountorin välille.
Tekniikaltaan Procountor API on toteutettu noudattaen REST-periaatetta (Representational state transfer), joka on tapa rakentaa HTTP-kutsuihin pohjautuva rajapinta- tai järjestelmäarkkitehtuuri. Tiedonsiirtomuotona käytetään JSONia ja autentikoinnissa mukaillaan OAuth2-prosessia.
Palveluun liittyvä julkinen dokumentaatio löytyy erillisestä verkko-osoitteesta https://dev.procountor.com/. Procountor APIin liittyvissä yleisissä kysymyksissä ja muun muassa lisäpalveluiden tilauksissa asiantuntijamme ovat tavoitettavissa osoitteesta integrations@procountor.com.
API-rajapintaan liittyvistä mahdollisista virhetilanteista ilmoitetaan Häiriötiedotteet-sivulla.
Rajapinnan osat
Rajapinnan kautta on mahdollista niin luoda, noutaa, päivittää kuin tarvittaessa poistaakin kattavasti erilaisia tietoja. Dokumentaatiosivuston API Reference -osiosta on nähtävissä, mitkä toiminnot rajapinnan kautta ovat tällä hetkellä mahdollisia. Rajapinnassa käytetään HTTP-kutsuja alla esitellyin periaattein:
- GET - noudetaan jokin resurssi, esimerkiksi lasku Procountorista
- POST - luodaan jokin resurssi, esimerkiksi muistiotosite Procountoriin
- PUT - päivitetään jotakin resurssia, esimerkiksi hyväksytään Procountorissa oleva ostolasku
- DELETE - poistetaan jokin resurssi, esimerkiksi mitätöidään Procountorissa oleva lasku
Procountor API kehittyy jatkuvasti ja siihen lisätään uusia osia tulevien versiopäivitysten yhteydessä. Dokumentaatiosivujemme Release notes -osiosta löytyy tietoa versiopäivityksissä rajapintaan julkaistavista uusista osista ja Subscribe-osion kautta on mahdollista liittyä myös API-postituslistalle.
Palvelun hinnoittelu
Procountor API on erillinen lisäpalvelu, jonka käytöstä veloitetaan yrityskohtainen kuukausiveloitus Accountor Finagon palveluhinnaston mukaisesti. Rajapinnan kautta Procountoriin luoduista tositteista veloitetaan tositeperusteisesti hinnaston mukaisesti.
Uusien integraatioiden rakentamisen ja käyttöönoton tueksi tarjoamme myös konsultointia, jossa integraatioasiantuntijamme kanssa käydään tarkemmin läpi integraatioon liittyviä prosesseja ja rajapinnan dokumentaatiotamme. Konsultoinnin voi tilata osoitteesta integrations@procountor.com ja sen veloituksesta löytyy tarkempaa tietoa hinnastostamme.
Toimenpiteet palvelun käyttöönottoa varten
Palvelun käyttöönotto edellyttää, että toisesta ohjelmistosta tai järjestelmästä on rakennettu tai rakennetaan integraatio Procountorin APIa vasten. Uusissa integraatioissa asiakkaan tai jonkin kolmannen tahon vastuulla on rakentaa Procountoriin integroitavaan järjestelmään rajapinta kutsujen lähettämiseksi ja vastaanottamiseksi. Palvelun testitunnukset ovat tilattavissa dokumentaatiosivustomme lomakkeen kautta ja testaus on täysin veloituksetonta. Dokumentaatiosivustomme lomakkeen löydät tästä linkistä.
Listauksen ja tarkempia tietoja olemassa olevista Finago Network -kumppaniohjelmaan kuuluvista API-teknologialla toteutetuista integraatioista löydät nettisivuiltamme: Ohjelmistokumppanit. Valmiin integraation käyttöönotto tapahtuu pääosin toisen ohjelmiston puolella heidän ohjeistuksensa mukaisesti.
Procountor API:n irtisanominen
Mikäli ympäristössä on jokin ulkopuolinen API-integraatio käytössä, laskutetaan API-rajapinnan käytöstä kk-maksu. Laskutus perustuu ympäristön käyttöasetuksista löytyvään asetukseen, jolla laskutettavien rajapintojen käyttö on sallittu ympäristössä. Asetus, jolla voidaan estää ja sallia laskutettavien rajapintojen käyttö kyseisessä Procountor-ympäristössä, löytyy kohdasta: Hallinta > Yrityksen tiedot > Käyttöasetukset > Integraatioasetukset > Salli laskutettavien rajapintojen käyttö.
Mikäli jokin ulkopuolinen API-integraatio on ollut käytössä ja sen käyttö halutaan lopettaa, tulisi siitä ilmoittaa myös integraation tarjoajalle, jotta he lakkauttavat palvelun käytön ja mahdollisen oman laskutuksensa myös toisen järjestelmän päässä.