BlueBoard API

BlueBoard.cz nabízí k použití API, díky kterému lze strojově zpracovávat různá data kolem služeb BlueBoard.cz

Seznam nabízených API

Vkládání HTML kódů

Identifikace

API funguje na základě identifikace některého uživatele BlueBoard.cz. Ten se identifikuje podle tzv. API klíče, který může kdykoli získta v uživatelském rozhraní BlueBoard.cz.

Co API nabízí jak se to dá využít

API nabízí po zadání API klíče seznam většiny služeb, které má daný uživatel vytvořené. Seznamem je myšlen název služby a její HTML kód.

To lze využít v mnoha projektech, kde chcete nabídnout vložení například ankety, RSSBoardu, ShoutBoardu apod do nějaké prezentace nebo jiného výstupu vašeho uživatele. Ten si jenom ve vašem projektu zadá API klíč a na základě toho se mu objeví seznam jeho služeb na BlueBoard.cz Ty si může kliknutím už jenom vložit. Způsob realizace je ale samozřejmě na vás.

Dokumentace

API se volá pomocí následující URL:

http://miniaplikace.blueboard.cz/api/sluzby.php?apiklic=xxxx

Místo xxxx dosadíte API klíč, který zadá váš uživatel.

Tato URL vrátí XML výstup v této podobě:


<boards>
    <board type="anketa">
    <name><![CDATA[nazev 1]]></name>
    <code><![CDATA[<!-- BlueBoard.cz Anketa -->
    <iframe  width="155" height="204" frameborder="0" scrolling="no" src="http://blueboard.cz/anketa_0.php?id=1">
    <a href="http://blueboard.cz/anketa_0.php?id=1">Anketa</a> od <a href="http://blueboard.cz/">BlueBoard.cz</a>
    </iframe>
    <!-- BlueBoard.cz Anketa KONEC --> ]]>
    </code>
    </board>
    ...
</boards>

Výsledky z počítadla

Dokumentace

API se volá pomocí následující URL:

http://blueboard.cz/api/counter.php?id=xxx

Místo xxxx dosadíte id počítadla, které naleznete v nastavení počítadla na konci stránky.

Tato URL vrátí XML výstup v této podobě:


<counter id="221588">
    <total>388273</total>
    <today>
        <pageviews>9736</pageviews>
        <visits>1446</visits>
    </today>
    <yesterday>
        <pageviews>34360</pageviews>
        <visits>4276</visits>
    </yesterday>
</counter>

Další formáty

Výstup může být i ve formátu JSON. V tom případě se API volá takto:

http://blueboard.cz/api/counter.php?id=xxx&ouput=json

A výsledek bude v této podobě:


{
    "id":221588,
    "data":{
        "total":"388352",
        "today":{
            "pageviews":"10274",
            "visits":"1525"
        },
        "yesterday":{
            "pageviews":"34360",
            "visits":"4276"
        }
    }
}

Cizojazyčné verze

U služeb Návštěvní kniha, ShoutBoard a BlueForm lze použít anglické a slovenské mutace přidáním parametru do URL, kterým se zlužba volá:

lng=en
lng=sk

Případné dotazy ohledně použití API můžete psát na e-mail jirka@blueboard.cz.

© Blueboard.cz | Kontakty | Podmínky