REST API

Pro vytváření webových služeb pro Antelli je připravené jednoduché rozhraní. Webové služby můžete psát v čem umíte, ať už v Javě, Node.js, PHP nebo třeba v .NET, je to jen na vás, stačí dodržet specifikaci a Antelli vaší službě porozumí.

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

  1. Začněte metodou /meta, která ří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. V meta datech také můžete volitelně definovat, jaké hodnoty si uživatel může pro vaší službu nastavit. Tyto hodnoty pak odesílá s každým requestem a vy podle toho můžete přizpůsobit chování služby.
  2. Přidejte URL služby do Antelli a vyzkoušejte, jestli se meta data načítají správně.
  3. Další na řadě je metoda /can-answer, do které přijde v POST parametru otázka uživatele a vy vrátíte true/false, zda vaše služba umí na danou otázku odpovědět. Pokud to bude true, tak za pár okamžiků vám přijde ta stejná otázka ještě do metody /answer.
  4. Metodou /answer už vrátíte 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. 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 vy mu můžete vrátit podrobnosti. V response /answer také můžete klientovi poslat pole state (stav), které se bude klient následně posílat v dalších requestech a vy potom můžete 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živatelova kliknutí. Např. když do některé z odpovědí přidáte command="detail_1" a uživatel na ní klikne, tak se zavolá tato metoda s parametrem "detail_1" a vy podle toho vrátíte uživateli podrobnosti položky, která ho zaujala.

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

A to je vše. Implementace je opravdu snadná, pokud něco nebude jasné, napište na podpora@antelli.cz