Lounastaja voidaan integroida infonäyttöihin kahdella eri tavalla, käyttäen verkkosivu-upotusta tai rajapintaa.
Verkkosivu-upotuksen käyttäminen infonäytöissä
Verkkosivu-upotus lataa lounaslistan verkkosivuille pienen koodinpätkän avulla, jolloin samaa upotusta voi käyttää myös verkkopohjaisissa infonäytöissä. Lounaslista ladataan sivulle esimääritetyssä HTML-koodissa, jolloin upotuksen ulkoasuun voi käyttää meidän valmiita pohjia tai räätälöidä ulkoasun kokonaan itse.
Verkkosivu-upotuksen käyttämiseen löytyy tarkemmat ohjeet täältä. Upotusta käyttäessä asetuksista voi valita erikseen käyttöön infonäyttö-tilan jolloin upotus päivittyy infonäyttöön automaattisesti 5 minuutin välein.
Rajapinnan käyttäminen infonäytöissä
Rajapinta mahdollistaa lounaslista-datan haun JSON tai RSS-muodossa, jolloin infonäyttöjen sisältö voidaan räätälöidä täysin omaan formaattiin. Lounaslista ladataan API-pisteestä toimipisteen uniikilla API-avaimella. Datan voi hakea rajapinnasta itselle sopivin aikavälein.
Rajapinta löytyy osoitteesta https://europe-west1-luncher-7cf76.cloudfunctions.net/api/
Eri API-pisteitä lounaslistan hakuun on:
Nykyisen viikon lounaslista (JSON)
/v1/week/:apiKey/current
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/week/xxxx-xxxx-xxxx-xxxx/current
Hakee nykyisen viikon lounaslistan JSON-muodossa, sisältäen lounaslistan eri kieliversiot.
Aktiivisen viikon lounaslista (JSON)
/v1/week/:apiKey/active
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/week/xxxx-xxxx-xxxx-xxxx/active
Hakee nykyisen viikon lounaslistan JSON-muodossa, sisältäen lounaslistan eri kieliversiot. Aktiivinen viikko tarkoittaa nykyistä viikkoa, mutta se voi näyttää seuraavan viikon lounaslistan jo edellisenä viikonloppuna jos ravintola on niin määritellyt. Ravintola voi halutessaan valita, että seuraavan viikon lounaslista näkyy jo pe-la tai la-su yöstä eteenpäin.
Tietyn viikon lounaslista (JSON)
/v1/week/:apiKey/:year/:week
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/week/xxxx-xxxx-xxxx-xxxx/2024/8
Hakee halutun viikon lounaslistan JSON-muodossa, sisältäen lounaslistan eri kieliversiot. Huomaa, että Lounastajasta voi hakea vain nykyisen, edellisen tai seuraavan viikon lounaslistan.
Nykyisen viikon lounaslista (RSS)
/v1/rss/week/:apiKey/current?language=:lang
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/rss/week/xxxx-xxxx-xxxx-xxxx/current?language=fi
Hakee nykyisen viikon lounaslistan RSS-muodossa. Määrittele lounaslistan kieli lisäämällä parametri ”language”, jonka arvo on kieli ISO 639-1 -muotoinen kielitunnus (esim. fi, en, sv).
Aktiivisen viikon lounaslista (RSS)
/v1/rss/week/:apiKey/active?language=:lang
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/rss/week/xxxx-xxxx-xxxx-xxxx/active?language=fi
Hakee nykyisen viikon lounaslistan RSS-muodossa. Aktiivinen viikko tarkoittaa nykyistä viikkoa, mutta se voi näyttää seuraavan viikon lounaslistan jo edellisenä viikonloppuna jos ravintola on niin määritellyt. Ravintola voi halutessaan valita, että seuraavan viikon lounaslista näkyy jo pe-la tai la-su yöstä eteenpäin. Määrittele lounaslistan kieli lisäämällä parametri ”language”, jonka arvo on kieli ISO 639-1 -muotoinen kielitunnus (esim. fi, en, sv).
Nykyisen päivän lounaslista (RSS)
/v1/rss/week/:apiKey/current?language=:lang&days=current
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/rss/week/xxxx-xxxx-xxxx-xxxx/current?language=fi&days=current
Hakee nykyisen päivän lounaslistan RSS-muodossa. Määrittele lounaslistan kieli lisäämällä parametri language, jonka arvo on kieli ISO 639-1 -muotoinen kielitunnus (esim. fi, en, sv).
Tiettyjen viikonpäivien lounaslista (RSS)
/v1/rss/week/:apiKey/current?language=:lang&days=:days
Esim. https://europe-west1-luncher-7cf76.cloudfunctions.net/api/v1/rss/week/xxxx-xxxx-xxxx-xxxx/current?language=fi&days=1,2,3,4,5
Hakee haluttujen viikonpäivien lounaslistan RSS-muodossa. Määrittele halutut viikonpäivät lisäämällä parametri days, jonka arvo on pilkuilla eroteltu lista viikonpäivien numeroista (0-6, 0 = sunnuntai, 1 = maanantai, 2 = tiistai jne.) Määrittele lounaslistan kieli lisäämällä parametri language, jonka arvo on kieli ISO 639-1 -muotoinen kielitunnus (esim. fi, en, sv).
Jos ravintola ei ole julkaissut lounaslistaa, rajapinta antaa 404-virhekoodin viestillä ”No published week available”.