👋 Vítejte v dokumentaci aplikace Search Ready

Search Ready je aplikace pro vyhledávání nad obsahem vašeho webu nebo e-shopu. SR v současné době používá tzv. Single Tenant architekturu, kdy každý zákazník používá svoji vlastní instanci aplikace. Z těchto důvodů je před začátkem jakékoli práce s naším API potřeba kontaktovat naši podporu info@searchready.cz a domluvit spuštění nové instance SR.

Jakmile máte jako klient SR k dispozici svoji vlastní instanci SR, můžete začít plnit data. Nejjednodušší a nejrychlejší způsob je založení nových indexů přes webové admin rozhraní SR. Tento způsob vyžaduje přípravu dat ve struktuře uvedené v sekci XML feeds. O pravidelnou aktualizaci dat se již postará SR aplikace sama. Aktualizace probíhají defaultně jednou denně. Dalším možným způsobem je vložení dat přes naše Backend API. Tento způsob vám dodá větší flexibilitu a možnost aktualizovat data real-time. Změna na klientském backendu se ihned projeví v SR datech.

  • BACKEND API slouží pro přímý přístup do našeho backendu a manipulaci s daty.
  • XML Feeds slouží pro pravidelný import dat do našeho backendu.

Součástí SR aplikace je i frontedová javascriptová aplikace tzv. SERP. Tento SERP zajišťuje komunikaci se SR backendem a zobrazení výsledků vyhledávání. V případě, že se rozhodnete použít vlastní frontendové rozhraní pro zobrazení výsledků, máte k dispozici naše SERP API.

  • SERP API slouží pro komunikaci mezi frontendovou aplikací tzv. SERP (SearchEngineResultPage) a Search Ready backendem.

Built with ❤️ by Media Factory team.