Cardu-integraatio

Owned by Tommi Savikko
Jul 13, 2020
2 min read

Ohjelmistossa on kaksi merkittävää Cardu-integraatiota:

  1. Ohjelmiston sisäinen integraatio
    1. Tavoitteena tuottaa järkevä malli, jolla saadaan asiakkaalle "tulostettua" kanta-asiakaskortti
    2. Integraatio myös määrittää tiedot, jotka Carduun lähetetään
  2. SKJScriptillä toteutettu integraatio
    1. Tämä integraatio tekee kahta asiaa:
      1. Cardun kautta perustettujen asiakkaiden perustus järjestelmään
      2. Järjestelmässä muuttuneiden tietojen päivitys Carduun


Ohjelmiston sisäisestä integraatiosta on dokumentaatio täällä: Cardu.

SKJScript-toteutuksella saavutetaan seuraavat hyödyt:

  • Asiakkaat voivat lisätä kanta-asiakaskortin Cardu-lompakkoonsa suoraan Cardu-sovelluksessa
  • Asiakastiedot päivittyvät Cardu → SKJ automaattisesti
  • Asiakasnumeroista ei tarvitse huolehtia: Integraatio perustaa halutulle asiakasnumeroalueelle SKJ-asiakkaan ja lähettää asiakasnumeron heti perustuksen jälkeen takaisin Carduun
  • Mikäli asiakas on jo olemassa järjestelmässä, käytetään vanhaa asiakasnumeroa (täsmääminen tapahtuu puhelinnumeron perusteella)
  • Mikäli käytössä on bonusjärjestelmä, lähettää järjestelmä ostokertymä/bonustiedot Carduun

SKJScriptillä toteutettu integraatio käyttöönotetaan seuraavasti: Cardu

  1. Tilataan Cardu-integraatiolisenssi SKJ:lta
  2. Ladataan integraatio-komponentit
  3. Asetetaan asetukset
  4. Testataan integraatio
  5. Asetetaan integraatio palveluksi
  6. Varmistetaan, että palvelu toimii


Asetukset

Asetukset löytyvät tiedostosta carduinconfig.pas:

procedure setconfig;
begin
  logentry('Luetaan asetukset tiedostosta carduinconfig.pas');
  dbname := 'TIETOKANTA'; // Tietokanta, johon tietoja päivitetään
  cardid := 'abcdef';
  customerNumberField := 'customerId'; // kenttä, johon skj:n asiakasnumero kytketään
  getdays := 1; // kuinka monen päivän ajalta haetaan tietoja
  user := 'user@example.com'; // http basic auth user
  pass := 'password'; //                 pass
  kantaasiakas := 1; // haluatko asettaa kanta-asiakas -ruksin päälle kun asiakas lisätään? 1=kyllä 0=ei
  asiakasryhma := 99; // asiakasryhma, johon asiakas perustetaan
  asiakasalku := 1; // asiakasnumerovälin, mihin asiakas perustetaan, ensimmäinen mahdollinen numero HUOM! Asiakasnumerovälillä tulee olla perustettuna vähintään yksi asiakkuus
  asiakasloppu := 1000; //asiakasnumerovälin, mihin asiakas perustetaan, viimeinen mahdollinen numero
  host := 'https://integrationapi.cardu.com'; // url, johon otetaan yhteys
  cardsurl := '/rest/cards/'; // apin tarkempi endpoint
end;
  • Tietokanta: asetetaan tietokanta, johon asiakkaat perustetaan
  • Cardid: Cardu-kortin id (sama, mikä on asetettu Tiedosto → Asetukset → Cardu -välilehdelle)
  • customerNumberField: Cardun kenttä, johon asiakasnumero on viety (oletuksena customerId)
  • getdays: Kuinka vanhoja asiakkuuksia Cardusta haetaan - normaalikäytössä arvo on hyvä olla alle 10, mutta jos halutaan esimerkiksi tuoda vanhat Cardu-asiakkuudet sisään niin päiviä on hyvä lisätä, jotta vanhatkin Carduun perustetut asiakkaat päätyvät SKJ:hin
  • user: Cardun integraatiokäyttäjätunnus
  • pass: Cardun integraatiokäyttäjän salasana
  • kantaasiakas: Asetetaanko kanta-asiakas -ruksi päälle kun asiakasta perustetaan (mm. bonuskäsittely vaatii ko ruksin)
  • asiakasryhmä: Mikä asiakasryhmä asetetaan perustetulle asiakkaalle
  • Asiakasnumeroavaruus:
    • Huom! Asiakasnumeroväli voi olla samalla välillä kun muutkin perustetut asiakkat, tältä väliltä katsotaan aina seuraava vapaa numero
    • asiakasalku: Asiakasnumeroavaruuden ensimmäinen numero
    • asiakasloppu: Asiakasnumeroavaruuden viimeinen numero
  • host / cardsurl: Cardun integraatiopalvelun osoite, lähtökohtaisesti ei tarvitse muokata


Testaaminen


  1. Aja skjscript käsin:
    1. C:\WINSKJ\SKJSCRIPT.EXE /F:C:\WINSKJ\CARDU\CARDUIN.PAS /RUN
    2. Tarkista skjscript.log -tiedosto, katso suorittuiko ajo ilman virheitä
  2. Perusta Carduun yksi asiakas
  3. Aja integraatio
    1. Tarkista, että asiakas perustui oikein järjestelmään
    2. Tarkista skjscript.log -tiedoto, katso suorittuiko ajo ilman virheitä
  4. Tee asiakkaalle yksi bonusosto
    1. Tarkista, että asiakkaalle kirjautui ostokertymä
  5. Aja integraatio
    1. Tarkista, että ostokertymä päivittyi oikein Carduun
    2. Huomaa, että ostokertymä tulee olla asetettu Cardu-asetuksiin lähetettäväksi kentäksi


Integraation asettaminen palveluksi

Integraatioon kuuluu myös tiedosto cardu-integration.cmd

Tarkista tiedoston sisältö, eritoten kaikki sen polut.

Testaa integraation toimivuus suorittamalla komentojono. Tarkista lokimerkinnät mikäli integraatio ei toimi.

Asenna integraatio palveluksi:

nssm Cardu C:\WINSKJ\Cardu-integration.cmd

Käynnistä palvelu (net start Cardu). Testaa integraation toiminta.