Developer Tools: API

Application Programming Interface (API)

Aplikácia BibleSearch - Application Programming Interface (API) umožňuje každému programátorovi zahrnúť obsah a text Písma kdekoľvek na ich web stránku alebo použiť aplikáciu na nekomerčné účely. Ak nieste programátor a chcete zaradiť obsah Písma alebo BibleSearch na vašu vew stránku, pozrite sa na niektoré z našich pomocných programov tu. Pre vás autorov, BibleSearch je založená na REST API a kompletnú dokumentáciu môžete čítať tu.

Prosím prečítaje si nasledujúce najčastejšie kladené otázky, aby ste pochopili ako môžete BibleSearch API používať. Ak máte akékoľvek otázky, neváhajte ísť na naše API fórum a zverejnite otázku. Tiež sa s nami môžete spojiť cez email na support@bibles.org s predmetom API.

Ako môžem získať prístup?

Aby ste mali prístup k API, musíte byť zaregistrovaný používateľ BibleSearch a musíte mať aktivovaný váš osobitý API symbol, ktorý môžete získať prihlásením sa tu. Keď už budete mať vlastný API symbol, môžete volať na API a načítať obsah. Prosím, pamätajte, že každý telefonát musí obsahovať tento API symbol. Váš API symbol je pre vás jediný. Mal by ostať utajený, preto si ho s nikým iný nezdieľajte.

Ako môžem používať získané údaje?

Získaný obsah Písma z API nemôžete použiť na žiadne komerčné účely, ani na iné použitie, ktoré je protiprávne, útočné, násilné, nemorálne alebo hanlivé voči iným alebo voči samotnému Písmu. Jednoducho sa správajte čestne. Neupravujte ani nemeňte význam Písma, ani to ako by malo byť vyložené.

Ak chcete použiť tento obsah na obchodné účely, musíte získať špecifický súhlas, ktorý môžete získať ak nás kontaktujete na email support@bibles.org s uvedeným predmetom API. Okrem toho vás žiadame, aby ste naraz zobrazovali len 500 veršov nasledujúcich po sebe, a vždy súčasne so zobrazeným obsahom Písma, uviedli informáciu o autorských právach verzie, ktorú používate. Môžete si tiež prezrieť skompletizované podmienky pre API tu.

Aký druh aplikácií môžem vytvoriť?

Pokiaľ používate obsah Písma na nekomerčné účely, spôsobom, ktorý rešpektuje celistvosť textu Písma ako je popísané v predchádzajúcom odseku, môžete vytvoriť čokoľvek by ste chceli. Vždy nás zaujíma čo developeri vymyslia, takže vás prosíme, aby ste svoju tvorbu zdieľali s nami a s ostatnou komunitou na BibleSearch API fóre.

Aké verzie sú k dispozícií?

Aktuálne vieme ponúknuť len verzie, ktoré sú uvedené nižšie. Chceme vám sprístupniť čo najviac verzií, ale najskôr musíme zapojiť viaceré vydavateľstvá. Ak by ste naozaj chceli mať prístup k niečomu navyše, dajte nám o tom vedieť emailom alebo na našich fórach a urobíme, čo bude v našich silách, aby sme vám pomohli.

View Available API Versions

Prečo nie je v ponuke viac verzií Písma?

Verzie Písma sú duševným vlastníctvom rôznych vydavateľstiev a majiteľov licencií. Aby sme mohli sprístupniť verziu cez API, potrebujeme najskôr špeciálne povolenie od týchto vydavateľstiev. Ak by ste nejakú verziu chceli, najrýchlejšia cesta ako ju získať je požiadať o ňu na našom BibleSearch API Fóre. Ak budeme vedieť o akú verziu máte záujem, môžeme kontaktovať vydavateľstvá a snažiť sa ako najlepšie vieme, aby sme vám ju sprístupnili.

Aby sme podporili dôveru medzi nami, vydavateľstvami a držiteľmi duševného vlastníctva, sme v API vytvorili Fair Use Management System. Toto nám pomáha zaobstarať si viac dát o tom ako je obsah Písma používaný užívateľmi API a tiež skončenie vašej aplikácie. Snažíme sa hlavne zdôrazniť prehľadnosť toho ako je obsah Písma používaný cez API, a tak ukázať vydavateľstvám a držiteľom duševného vlastníctva, že ich obsah chránime a zabezpečujeme udržanie celistvosti, ktoré si Písmo vyžaduje.

Čo je Fair Use Management System?

Fair Use Management System nám slúži na to, aby sme videli ako sa používa obsah Písma prostredníctvom API. Preto kde uverejníte niečo z API na vašej stránke, uveďte tam aj malý odkaz JavaScript kódu. API vždy poskytne presný JavaScript kód na obsah, ktorý ste žiadali, takže ho môžete jednoducho pridať na vašu stránku.

Prečo vyžadujete používanie Fair Use Management System?

Fair Use Management System poskytuje informácie pre vydavateľov a ukazuje im, ako je ich obsah používaný. Vďaka tomu, že vydavateľstvá majú dodatočný dosah na API, tam budú pridané ďalšie verzie Písma. Tiež to prináša hodnotné informácie, ktoré nám pomáhajú vymedziť náš perspektívny vývoj, rozšírenie API tak, aby sme zahrnuli vybavenie a údaje, ktoré sú dôležité pre používateľov API.

Aké sú dôsledky Fair Use Mangement Systému na moju aplikáciu?

Fair Use Management System (FUMS) má minimálny vplyv na vašu aplikáciu. Optimalizovali sme kód aj dodatok JavaScript, aby sme sa uistili, že to nebude mať dopad na navštevníkov, ktorí budú používať API. FUMS nevyužíva osobné identifikačné údaje. Navyše, keďže pokračujeme v rozvíjaní FUMS, budete môcť mať prístup k rozšíreným štatistikám, ktoré ukážu ako sa údaje API, ktoré zobrazujete na vašej stránke, využívajú vašimi používateľmi.

Môžem údaje uskladniť do medzipamäte (cache)?

Áno, ale požadujeme, aby ste to obmedzili na menej ako http://support.bibles.org/categories/11919-biblesearch-api veršov. Taktiež odporúčame aby ste uskladnené údaje vymazali každých 14 alebo menej dní, pretože neustále aktualizujeme a vylepšujeme štruktúry našich dát aby vám boli ľahšie prístupné. Preto je lepšie neuskladňovať údaje príliš dlho. Chceme, aby ste mali vždy čo najaktuálnejší dostupný obsah Písma.

Koľko žiadostí môžem mať za jeden deň? Je to limitované?

Áno, je to limitované. Môžete realizovať len 5 000 požiadaviek za deň. Ak tvoríte obsiahlu aplikáciu, kde je nutné realizovať viac požiadaviek za deň ako je daný limit, prosím, kontaktujte nás emailom alebo na našom fóre aby sme vyriešili ako vyhovieť vašim požiadavkam. Skutočne vám chceme poskytnúť prístup k obsahu Písma, ktorý potrebujete a zároveň ochránili naše servery.

Môžem si vyžiadať povolenie aby som prekročil denný limit?

Určite sme tomu otvorení. Stačí nám napísať support@bibles.org do predmetu uviesť API a oboznámiť nás na čom pracujete, a aký prístup by ste potrebovali. S radosťou budeme s vami spolupracovať a vyhovieť tak vašim požiadavkam.

Ako používať API?

Na začiatok vám odporúčame prečítať si kompletnú dokumentáciu aby ste videli, aké možnosti a obmedzenia má súčasná API. Ak vám to stále nieje jasné, navštívte našeBibleSearch API Fórum a požiadate o pomoc. Fórum čítame denne a odpovieme vám na vaše otázky, prípadne poskytneme riešenie chýb. Ak potrebujete okamžitú pomoc, predložte požiadavku na fóre a odpovieme vám ako najrýchlejšie vieme.

Musím zobraziť copyright pre každú verziu, ktorú mám na stránke?

Áno. Je dôležité ukázať, že vydavateľstvo vlastní práva pre príslušnú verziu Písma. Preto vás prosíme, aby ste zobrazili informáciu o copyright-e pri všetkých verziách Písma.

Ako môžem vložiť moju verziu do API?

Ak ste vydavateľ alebo držiteľ duševného vlastníctva, a chcete aby vaša verzia Biblie bola k dispozícií na BibleSearch a cez API, veľmi radi sa s vami spojíme. Napíšte nám support@bibles.org

Čo ak ste tu nezodpovedali na moju otázku?

Máme pre vás fórum aby ste prehľadali otázky a príspevky ostatných a tiež aj články nášho tímu vývojárov. Ak tam nenájdete to čo hľadáte, a chcete okamžitú pomoc, napíšte nám na support@bibles.org a ako predmet uveďte API.