MyCashflow REST API:n avulla voit integroida verkkokauppasi lukuisiin kolmansien osapuolien sovelluksiin, esim. CRM-, taloushallinto- ja kirjanpitojärjestelmiin.

API:n käyttäminen edellyttää ohjelmointiosaamista. API:a käyttämällä verkkokaupallesi voidaan kehittää rajapintasovellus, joka välittää tietoa verkkokauppasi ja haluttujen ulkoisten sovellusten välillä.

MyCashflow API on käytössä vain seuraavissa palvelupaketeissa:

  • Advanced
  • Pro
  • Enterprise

Hinnoittelu

Laajennuksen käyttö on maksutonta.

Käyttöönotto

Ensin sinun on otettava API-laajennus käyttöön verkkokaupassa.

  1. Kirjaudu sisään verkkokaupan hallintaan osoitteessa https://KAUPAN-NIMI.mycashflow.fi/flow, jos et vielä ole kirjautunut sisään.
  2. Mene ylävalikon kautta sivulle Tili > Laajennukset > API.
  3. Paina Tilaa laajennus -painiketta.

API-laajennus on nyt käytössä verkkokaupassasi. Seuraavaksi sinun on luotava API-käyttäjiä rajapintasovelluksia varten.

API-käyttäjien luominen

API-käyttäjän tiedoissa määritellään rajapintasovellukseen kirjautumisessa käytettävät tunnukset. Jokaiselle rajapintasovellukselle on yleensä hyvä luoda oma API-käyttäjä.

  1. Mene ylävalikon kautta sivulle Tili > Käyttäjät.
  2. Vasemman reunan Rajapintatunnukset-valikossa paina Lisää tunnus -painiketta.
  3. Syötä integraation nimi ja API-käyttäjän sähköpostiosoite.

    Sähköpostiosoite toimii rajapinnan käyttäjäntunnuksena yhdessä rajapinta-avaimen kanssa. Lue lisää rajapinta-avaimista ›

    API-dokumentaatiosta löydät tarkempaa tietoa tunnistautumisesta rajapintasovelluksessa.

  4. Paina Tallenna-painiketta.

    Kopioi rajapinta-avain heti luotuasi käyttäjän.

    Rajapinta-avain näytetään vain kerran API-käyttäjän luonnin jälkeen.

    Jos kadotat rajapinta-avaimen, voit luoda uuden API-käyttäjän lomakkeella.

Rajapinta-avaimet

API-käyttäjälle luodaan rajapinta-avain automaattisesti käyttäjän luonnin yhteydessä. Luotu avain näytetään vain kerran ensimmäisen tallennuksen jälkeen, mutta voit luoda käyttäjälle uusia rajapinta-avaimia tarpeen vaatiessa.

Rajapinta-avainta käytetään salasanana kutsujen todentamisessa. API-dokumentaatiosta löydät tarkempaa tietoa tunnistautumisesta rajapintasovelluksessa.

Näin luot käyttäjälle uuden rajapinta-avaimen:

  1. Avaa API-käyttäjän tiedot muokattavaksi Tili > Käyttäjät -sivulla.
  2. Valitse Luo uusi avain.
  3. Paina Tallenna-painiketta.

Löydät uuden avaimen käyttäjän tiedoista tallennuksen jälkeen. Kopioi avain talteen, sillä se näytetään vain kerran.