Blábot pro vás generuje hezké české Lorem ipsum

Pro developery

---

Jako každý slušně vychovaný robot má i Blábot své aplikační rozhraní. Blábota tak můžete spojit se svými aplikacemi či službami a nechat je společně blábolit v robotštině.

Specifikace rozhraní

Aktuální verze rozhraní 1.0Beta (10b) je dostupná na adrese http://api.blabot.net prostřednictvím HTTP GET požadavku. Tato verze představuje první veřejně dostupné rozhraní Blábota. Přesto, že jsme provedli interní testy, očekáváme, že integrace v reálném životě odhalí nějaké nedostatky a proto tedy nese označení Beta. Těšíme se také na  rozhraní.

Parametry

Scount (integer)

Nejmenší jednotkou odpovědi Blábota je jedna věta. Parametr „scount“ (sentences count) určuje počet vět, které má Blábot ve své odpovědi vygenerovat. Defaultní hodnota parametru je 10 vět, maximální pak 100 vět.

http://api.blabot.net?scount=15

Method (paragraph|list)

Blábot umožňuje volbu metody „paragraph“ nebo „list“. Vygenerované věty pak vrací jako jeden blok (paragraph) nebo odděleně jako seznam (list). Defaultní hodnotou parametru je metoda „paragraph“.

http://api.blabot.net?method=list

Format (json|xml|php)

Formát odpovědi můžete získat jako pole formátu JSON, serializované pole jazyka PHP, nebo jako XML dokument. Defaultní hodnotou parametru je formát JSON.

http://api.blabot.net?format=xml

Language (cs)

Blábot je do budoucna připraven naučit se nejen nové slovníky, ale také nové jazyky. Prozatím je jedinou možnou a defaultní hodnotou parametru hodnota „cs“.

Dictionary (integer)

K dispozici jsou v rámci českého jazyka tři slovníky identifikované pod svými ID následovně:

1. Čapkovská čeština
2. Moderní čeština
3. Právnická čeština

Defaultní hodnotou prametru je slovník č.1.

http://api.blabot.net?dictionary=3

Version (10b)

Defaultní hodnotou parametru je vždy poslední platná verze rozhraní. Doporučujeme proto vašich dotazech na API vždy uvádět parametr verze, pro kterou byla integrace realizována a předejít tak chybám v důsledku zpětné nekompatibility.

http://api.blabot.net?version=10b

Omezení (flood filter)

Blábot ještě není zcela dospělým robotem. Implemetovali jsme proto na jeho ochranu fitr omezení počtu dotazů v čase (tzv. flood filter).

Limit filtru je aktuálně nastaven na 60 dotazů / 60 sekund z jedné IP adresy. Jsme si vědomi nedokonalosti filtrace na základě IP adresy. Naše představa o možném zatížení rozhraní je také velmi mlhavá. Budeme pečlivě sledovat statistiky rozhraní a naslouchat vašim návrhům.

Při překročení limitu vrátí rozhraní chybu 403 a na dobu 48 hodin umístí IP adresu do karantény. Pokud jsou z IP adresy umístěné v karanténě nadále zasílány požadavky, je tato definitivně přesunuta na black list.

Historie verzí

1.0 Beta (10b)

• první veřejné rozhraní Blábota

Plány do budoucna

• Rozšířit jazykovou/slovní zásobu Blábota zejména o slovenčinu a španělštinu.
• Implementovat další metody rozhraní, zejména pro získání dostupných jazykových mutací a slovníků. Vizí je plnohodnotné REST API.
• Implementovat ochranu prostřednictvím developerských klíčů a jejich správy, které by měla být řešením nedokonalosti flood filtru.
• Implementovat pokročilé statistik zatížení rozhraní