REST API

Pro vytváření webových služeb pro Antelli je připravené jednoduché rozhraní, jeho podoba je více méně finální, maximálně přibude nějaká forma autentifikace. Webové služby můžeš psát v čem chceš, ať už PHP, Node.js nebo třeba v Javě, je to jen na Tobě, stačí dodržet specifikaci a Antelli Tvojí službě porozumí.

Kompletní specifikace rozhraní je na Apiary: https://app.apiary.io/antelli

  1. Začni metodou /meta, ta říká Antelli veškeré důležité informace pro uživatele o službě jako je název, autor, popis a příklady otázek, na které se může zeptat. Brzy bude možné v meta i specifikovat, co si uživatel pro Tvojí službu bude moci v Antelli nastavit. Toto nastavení se potom bude posílat za aplikace na další metody a služba se podle toho může zachovat různě.
  2. Přidej URL služby do Antelli a vyzkoušej, jestli se meta data načítají správně.
  3. Další na řadě bude metoda /can_answer, do které jde na vstupu otázka uživatele a Ty vrátíš true/false. Pokud to bude true, tak za pár okamžiků Ti přijde ta stejná otázka ještě do metody /answer.
  4. Metoda /answer už vrátí konkrétní odpověď uživateli. Odpověď může obsahovat jednu a více položek (items), každá z nich je potom v Antelli reprezentovaná jako jedna karta, která může obsahovat title, subtitle, text, image (absolutní URL) a speech (text, který se uživateli přečte nemusí být stejný, jako ten, který se zobrazuje). Parametr command se potom používá na kliknutí, když uživatel na položku klikne, tak se zavolá metoda /command s tímto parametrem a Ty mu můžeš vrátit podrobnosti k té položce. V response /answer také můžeš klientovi poslat pole state (stav), které se bude následně posílat v dalších requestech a Ty pak můžeš podle toho měnit chování v metodách /can_answer /answer nebo /command.
  5. Jak už bylo zmíněno výše, metoda /command (nepovinná) odpovídá na uživatelovy kliknutí. Např. když do některé Answer Item dáš command="detail_1" a uživatel na ní klikne, tak se zavolá tato metoda s parametrem "detail_1" a Ty podle toho vrátíš uživateli podrobnosti položky, která ho zaujala.

Demo služba běží na http://antelli.cz/api_demo

A to je vše, můžeš se do toho pustit! Kdyby sis s něčím nevěděl rady, zeptej se v komunitě na Google+.