Interface-tageja on mahdollista kutsua myös käyttämällä ohjelmointikieliä, kuten PHP:tä tai Javascriptiä (palvelinpuolten ohjelmointikielten käyttäminen MyCashflow'ssa ei kuitenkaan ole mahdollista).

Käyttämällä tageja ohjelmointikielien avulla voit esimerkiksi hakea sanakirjatyökalusta sisältöä AJAX-kutsuilla, tai tulostaa tuotelistan verkkokaupasta jollekin toiselle verkkosivulle.

Mikäli olet integroimassa verkkokauppaasi johonkin ulkoiseen ohjelmistoon, käytä MyCashflow'n REST -ohjelmointirajapintaa verkkokaupan sisällön käsittelyyn ja noutamiseen.

Syntaksi

Jokaisella Interface-tagilla on verkkokaupassa oma yhteyspiste, jonka osoite on seuraavassa muodossa:

https://verkkokaupan-nimi.mycashflow.fi/interface/TaginNimi?attributti=arvo

Mikäli kutsuttavalla tagilla on attribuutteja, niille voidaan antaa arvoja lisäämällä ne tagin yhteyspisteen osoitteeseen GET-parametreina, kuten yllä.

Näkymä tagien yhteyspisteissä

Tiettyjen tagien käyttäminen vaatii, että niiden käyttöympäristössä on asetettu näkymäksi jokin sisältötyyppi, kuten tuote. Tällaisia ovat esimerkiksi tuotteiden tietoja tulostavat tagit, kuten {ProductName}, jotka toimivat vain ympäristössä, jossa on valittu tai muuten määritetty näkymäksi jokin tuote.

Kun tageja kutsutaan ohjelmointikielillä, näkymä on asetettava kutsun yhteydessä käyttämällä set-parametreja:

Parametri Vastaa osoitetta
setProduct=id /product/id/...
setCategory =id /category/id/...
setBrand=id /brand/id/...
setPage=id /page/id/...
setNewsItem=id /news/id/...

Tuotepaketeille ei tällä hetkellä ole omaa yhteyspistettä Interface-järjestelmässä.

set-parametrit asetetaan samalla tavoin GET-parametrina kuin muutkin tagille annettavat attribuutit:

http://verkkokaupan-nimi.mycashflow.fi/interface/ProductName?setProduct=24

Esimerkin tagikutsu tulostaisi siis saman sisällön kuin {ProductName}, kun sitä käytetään tuotteen sivulla, jonka ID-numero on 24.

Attribuutit

Useimpia Interface-tagien attribuutteja on mahdollista käyttää kutsuttaessa tageja ohjelmointikielillä.

Alla on esitelty erityyppisten attribuuttien syntaksi Interface-tagien yhteyspisteissä.

Kuva 1. Teksti, numerot ja totuusarvot

Esimerkiksi sanakirjan sanoja haettaessa käytetään merkkijonomuotoisia arvoja:

https://kauppa.mycashflow.fi/interface/Text?code=AboutUs

Numeromuotoisia arvoja annetaan muun muassa kun määritetään haettavan sisällön ID:

https://kauppa.mycashflow.fi/interface/Category?id=4&helper=helpers/helper-file

Joillekin attribuuteille annetaan totuusarvo (true / false):

https://kauppa.mycashflow.fi/interface/ProductName?setProduct=4&escape=true
Kuva 2. Listat

Joillakin tageilla on listamuotoisia attribuutteja, joiden syntaksi on samanlainen käytettäessä tageja sivupohjissa ja yhteyspisteen kautta.

https://kauppa.mycashflow.fi/interface/Products?id=1|4|45
Kuva 3. Tiedostoviittaukset

Joillakin tageilla on attribuutteja, joiden arvoksi annetaan tiedostoviittaus. Tällainen on esim. {Helper}-tagi, jota on käytetty alla esimerkkinä:

https://kauppa.mycashflow.fi/interface/Helper?file=helpers/helper-file

Tiedostoviittaus annetaan suhteessa käytössä olevan teeman juurihakemistoon.

Jos haettavassa tiedostossa käytetään esim. tuotteiden tageja, sinun on asetettava haluttu tuote setProduct-parametrin avulla. Lue lisää set-paramatreista.

JavaScript/jQuery (AJAX-pyynnöt)

Javascriptin avulla on mahdollista suorittaa asynkronisia kutsuja Interface-tageille. Tämä mahdollistaa muun muassa sisällön hakemisen sanakirjasta sivun lataamisen jälkeen.

$.get('http://demo.mycashflow.fi/interface/Text?code=TargetContent',
    function(data) {
        $('.result').html(data);
    }
);

Huomaa että tagien attribuutit annetaan GET-parametreinä kutsuttavan tagin osoitteessa. Esimerkissä käytetään {Text}-tagia, jolla haetaan sisältöä sanakirjasta. Tagille annetaan haettavan sanan koodi code-attribuutin arvona.

Pyyntö lähetetään käyttämällä jQueryn get()-funktiota. Pyynnön palauttama HTML-sisältö voidaan tämän jälkeen kirjoittaa haluttuun HTML-elementtiin.

PHP

Palvelinpuolen ohjelmointikieli PHP:n avulla on myös mahdollista hakea sisältöä MyCashflow-kaupasta.

Voit käyttää tagien kutsumiseen esimerkiksi PHP:n file_get_contents()-funktiota:

$new_products = file_get_contents("http://demo.mycashflow.fi/interface/NewProducts?limit=6");
echo $new_products;

Esimerkissä haetaan verkkokaupan kuusi uusinta tuotetta kutsumalla {NewProducts}-tagia.

Koska tagit palauttavat valmiiksi HTML-muotoiltua sisältöä, esimerkin $new_products-muuttujan sisältö voidaan tulostaa sivulle sellaisenaan.

Rajoitukset ja tiedossa olevat puutteet

/interface-osoitteen alta haettavissa tageissa on seuraavia tiedossa olevia puutteita ja rajoituksia:

  • Tilauksien tagit eivät ole käytettävissä
  • Joidenkin tagien toiminta perustuu kävijäkohtaiseen sessioon. Jos tageja kutsutaan palvelinpuolen ohjelmointikielellä (esim. PHP), niin kävijäkohtainen sessio täytyy välittää erikseen tai tagit eivät toimi oikein. Tämä rajoitus ei koske kaupan sisäisiä AJAX-kutsuja.

    Sessioon pohjautuvia tageja ovat muun muassa asiakastiedot ja ostoskorin tagit.

  • Kun tagin tulostus näytetään toisen verkkotunnuksen alla, tulee linkkien ja kuvien polun alkuun lisätä verkkotunnus, esim. href="http://www.mcf-kauppa.fi/product/3"