Kuinoma Apin käyttöohje

Tämän ohjeen avulla voit suunnitella omaan verkkopalveluusi toimivan lainausosion.

Kuinoma Api edellyttä seuraavaa:

  • Perustason php-tai ohjelmointiosaaminen,
    perustason css- ja html-osaaminen,
    palvelin, jossa toimii php:n file_get_contents -funktio tai vastaava.

Kuinoman Apin voit toteuttaa valmista php-skriptiämme muokkaamalla, tai oman toteutuksen itse ohjelmoimalla.

Easy way - valmis php

Katso esimerkit ja suunnittele oma vastaava lainaus- ja vuokrausosio.

Yksinkertainen malliesimerkki Kuinoman Apilla tehdystä lainaus- ja vuokrausosiota.

Lataa valmis skripti ja tyylitiedoto. Sijoita ne palvelimellesi. Muokkaa mieleiseksi.

Valmis php-skripti ja css (zip-tiedostona).

Pro way - toteuta oma tekninen toteutuksesi

Tutustu ohjeisiimme ja toteuta niiden avulla juuri haluamillasi tekniikoilla toimiva skripti tai palvelinsovellus Kuinoman Apille.

1. Suunnittele sivut

Sinun on suunniteltava millaisia lainaussivut ovat sinun palvelussasi. Lainausosio voi olla suppea käyttäjäkohtainen tai laaja ja yleinen, tai mitä vain siltä väliltä. Lainausosio voidaan muodostaa esimerkiksi halutuista Kuinoman Ryhmistä.

Yleisen lainausosion sivut

Sinun on suunniteltava millaisen yleisen lainausosion haluat palveluusi. Laajimmillaan tarvitset

  • a)pääryhmäsivut, b) alaryhmäsivut, c) tuoteryhmäsivut ja d) tuotesivut.

Kaikki sivutyypit eivät ole pakollisia. Alaryhmäsivut ovat itse asiassa identtisiä pääryhmäsivujen kanssa. Niiden tekninen toteutustapa on samanlainen. Jos käytät palvelussasi jotain pääryhmäsivua, niin et tarvitse ollenkaan siihen liittyviä alaryhmäsivuja. Pääryhmäsivu sisältää kaiken sisällön ja linkit, jotka olisivat myös siihen liittyvillä alaryhmäsivuilla.

Alaryhmäsivuja käytetäänkin tavallisten pääryhmäsivujen tilalla vain silloin, kun ei haluta esittää kokonaan jotain tiettyä pääryhmää, vaan poimia sieltä yksittäisiä alaryhmiä oman palvelun lainausosioon.

Voit myös toteuttaa erittäin kohdistetun lainaussivuston, jossa on vain tiettyjä tuoteryhmäsivuja ja niiden tuotesivuja. Sinun tulee valita omaan palveluusi sopiva laajuus ja valita sen mukaan palvelussasi esitettävät sivut ja sivutyypit.

Sivujen ulkoasua muokaat oman sivustosi css-tyylitiedoston avulla. Määritä tyylitiedostossa Apin käyttämät elementit sen näköisiksi kun haluat niiden olevan omassa palvelussasi

Apin pääryhmäsivun sisältö ja suunnitteluohje
Apin alaryhmäsivun sisältö ja suunnitteluohje
Apin tuoteryhmäsivun sisältö ja suunnitteluohje
Apin tuotesivun sisältö ja suunnitteluohje
Lista Apin kaikista käyttämistä css-tyylimäärityksistä

Käyttäjäkohtaisen lainausosion sivut

Voit toteuttaa lainausosion, jossa on esillä vain sinun omat tuotteesi, tai jonkun muun yksittäisen tai muutamien yksittäisten käyttäjien tuotteet. Käyttäjäkohtaiseen osioon tarvitset

  • a)käyttäjäsivut ja b) tuotesivut.

Apin käyttäjäsivun sisältö ja suunnitteluohje
Apin tuotesivun sisältö ja suunnitteluohje
Lista Apin kaikista käyttämistä css-tyylimäärityksistä

Kuinoman ryhmän sivut

Voit toteuttaa lainausosion, jossa on esillä vain sinun valisemasi Kuinoman ryhmä. Kuinoman ryhmän esittämiseen tarvitset

  • a)Kuinoman ryhmä -sivut ja b) tuotesivut.

Apin Kuinoman ryhmä -sivun sisältö ja suunnitteluohje
Apin tuotesivun sisältö ja suunnitteluohje
Lista Apin kaikista käyttämistä css-tyylimäärityksistä

2. Toteuta sivuihin muokkausskripti

Sivuja toteutettassa on käytettävä esim. php:tä. Usein käytetään file_get_contents -funktiota, joka mahdollistaa sisällön hakemisen Kuinoma Apin kaltaisesta ulkoisesta palvelusta.

Sinun on toteutettava skripti, joka (a) hakee oikean sisällön Kuinoma Apista ja (b) muokkaa sisältöä sinun sivuillasi toimivaksi.

Skriptin sijoitat omille lainausosion sivuillesi. Sinun palvelussasi edellä kuvatut sivut ovat esim.

  • http://www.esimerkki.fi/lainauspalvelu/paaryhma.php
    http://www.esimerkki.fi/lainauspalvelu/alaryhma.php
    http://www.esimerkki.fi/lainauspalvelu/tuoteryhma.php
    http://www.esimerkki.fi/lainauspalvelu/kuinoman_ryhma.php
    http://www.esimerkki.fi/lainauspalvelu/tuotesivu.php
tai voit tehdä vain yhden sivun, joka saa muuttujana sivutyypin. Tällöin sivut ovat esim.
  • http://www.esimerkki.fi/lainauspalvelu.php?sivu=paaryhma
    http://www.esimerkki.fi/lainauspalvelu.php?sivu=alaryhma
    http://www.esimerkki.fi/lainauspalvelu.php?sivu=tuoteryhma
    http://www.esimerkki.fi/lainauspalvelu.php?sivu=kuinoman_ryhma
    http://www.esimerkki.fi/lainauspalvelu.php?sivu=tuotesivu

Tekemäsi skriptin on noudettava oikea sisältö Kuinoman Apista. Skriptille on annettava muuttujana esim. perustieto haettavasta sisällöstä. Muuttujien mukaan on haettava Kuinomasta juuri muuttujaa vastaava sisältö.

Apin muokkausskriptin sisällönhakutoiminnon ohje

Tekemäsi skriptin on lisäksi tunnistettava Apin toimittamasta sisällöstä erilaisia muuttujia. Muuttujat ovat osa sisällössä olevia linkkejä. Muuttujat on pystyttävä erottelemaan linkeistä ja sen jälkeen niitä on käytettävä osana omaa palveluasi ja oman palvelusi lainausosioon johtavia linkkejä.

Apin muokkausskriptin linkkien käsittelytoiminnon ohje

Tekniset listat ja ohjeet

Lista ja ohje Apin tuottamista sivuista ja sivujen hakuosoitteet.
Esimerkkiskripti (php ja css). Esimerkkiskripti toimii sellaisenaan monissa php-pohjaisissa ympäristöissä. Esimerkkiskripti on helposti muokattavissa käyttöön esim. Drupalissa, WordPressissä, SMF:ssä ja muissa yleisissä php-pohjaisissa julkaisu- ja kehitysympäristöissä.

Pyydä lisätietoa ja ohjeita

Ota yhteyttä ja pyydä tarkemmat toteutusohjeet Apin käytöstä. Meiltä saat esimerkkejä toimivista skripteistä ja niiden haku- ja korvausfunktioista. Lisäksi saat esimerkkejä toteutettujen sivujen ulkoasusta ja käytetystä css-koodista. Lähetä yhteydenottopyyntö osoitteseen .