Yleistä
Procountor-API:n avulla Procountoriin voi liittää erilaisia ohjelmistoja ja automatisoida tiedonsiirtoa ohjelmistojen välillä. Rajapinnan kautta on mahdollista luoda, noutaa, päivittää kuin tarvittaessa poistaakin erilaisia tietoja. Procountor-API on saatavilla Procountor Taloushallinto -ympäristöihin (ei Procountor Tallennukseen).
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.
Procountor-API:iin liittyvissä yleisissä kysymyksissä ja muun muassa lisäpalveluiden tilauksissa asiantuntijamme ovat tavoitettavissa osoitteesta integrations@procountor.com.
API-rajapintaan liittyvistä mahdollisista yleisistä virhetilanteista ilmoitetaan Häiriötiedotteet-sivulla.
Toimenpiteet palvelun käyttöönottoa varten
Procountor-integraation, joka on toteutettu API-teknologialla, käyttöönotto ja aktivointi tapahtuu pääsääntöisesti toisesta ohjelmasta käsin ohjelmistotoimittajan tai integraation toteuttajan laatimia ohjeita noudattaen. Toisessa ohjelmistossa suoritettavien toimenpiteiden lisäksi myös integroitavaan Procountor ympäristöön tulee tehdä toimenpiteitä, jotta API-rajapinta saadaan käyttöön.
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 ohjelmistoyrityksien kumppaniohjelmaan kuuluvista API-teknologialla toteutetuista integraatioista löydät nettisivuiltamme: Ohjelmistokumppanit. Valmiin integraation käyttöönotto tapahtuu pääosin toisen ohjelmiston puolelta heidän ohjeistuksensa mukaisesti.
Rajapinnan osat
Procountor-API (Application Programming Interface) on ohjelmointirajapinta, jonka avulla on mahdollista tehdä ohjelmallisia kutsuja toisesta ohjelmistosta Procountoriin.
Rajapinnan kautta on mahdollista 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 uusi 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 Uutiskirjeen postituslistalle.
Palvelun hinnoittelu
Procountor-API on erillinen lisäpalvelu, jonka käytöstä veloitetaan integraatiokohtainen kuukausiveloitus Procountorin 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.
Procountor-API:n käyttötapaukset
Procountor-API:n yleisimpiä käyttötapauksia on kerrottu täällä (artikkelit englanniksi).
Palveluun liittyvä julkinen dokumentaatio
Procountor-API -rajapinnan tekniseen kuvaukseen ja ominaisuuksiin voi tutustua erillisellä Procountor-API -kehittäjäsivustolla (engl.kielinen), jonne on koottu kattava tietopaketti API-rajapinnastamme teknisestä näkökulmasta integraation kehittäjän avuksi ja tueksi. Sivustolle pääset tästä osoitteesta: https://dev.procountor.com/.
Procountor-API:n irtisanominen
Mikäli ympäristössä on jokin ulkopuolinen maksulliseksi asetettu API-integraatio käytössä, laskutetaan API-rajapinnan käytöstä kk-maksu. 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ä.