Developer Tools: API

interfaces de programas de aplicações (API)

A BibleSearch Application Programming Interface (API) permite a qualquer programador incluir textos e conteúdos da Escritura em qualquer lugar dos seus sites ou aplicações desde que seja para fins não comerciais. Se não é um programador e deseja incluir conteúdo ou o BibleSearch no seu site, veja alguns dos serviços que disponibilizamos para si aqui. Para os programadores, informamos que a API BibleSearch é baseada em REST. Toda a documentação e informações necessárias podem ser lidas aqui.

Por favor leia os seguintes FAQs afim de saber a melhor maneira de usar a API da BibleSearch. Se tiver alguma questão por favor use o nosso Forum API para a colocar. Também pode entrar em contacto connosco através do e-mail support@bibles.org colocando no Assunto a palavra API.

Como obter acesso?

Para aceder à API, tem de ser um utilizador registado na BibleSearch e ter activada a sua chave única de acesso. Pode-se registar aqui. Uma vez que tenha a sua chave de acesso à API, poderá então efectuar chamadas à mesma para obter conteúdos. Note que, em qualquer chamada que fizer, tem sempre de a incluir. Relembramos que a chave é única e secreta, não a partilhe com ninguem!

Como posso utilizar os conteúdos ?

Não pode de maneira alguma utilizar os conteúdos bíblicos retornados pela API para usos comerciais, nem em qualquer aplicação que seja ilegal, ofensiva, obscena, violenta, imoral ou depreciativa em relação a terceiros ou às Escrituras em si mesmas. Basicamente, seja correcto. Não altere ou mude o significado das Escrituras ou a maneira de a interpretar.

Se desejar utilizar os conteúdos retornados pela API para usos comerciais, necessita de obter autorização especial para tal contactando-nos via e-mail através do endereço support@bibles.org indicando a palavra API no Assunto. Além disso, pedimos-lhe para mostrar unicamente http://support.bibles.org/categories/11919-biblesearch-api versículos de cada vez e incluir sempre os Direitos de Autor para as traduções que for usando juntamente com os conteúdos das Escrituras que usar. Pode sempre consultar os Termos e Condições de utilização da API aqui.

Que tipos de aplicação posso desenvolver ?

Enquanto estiver a utilizar os conteúdos das Escrituras para uso não comercial, de uma maneira positiva e respeitando a integridade dos mesmos conforme descrito em cima, pode desenvolver o que quiser. Estamos sempre com curiosidade acerca do que os nossos utilizadores gostariam de desenvolver com a nossa API. Por favor partilhe a sua criatividade connosco e com a nossa comunidade de programadores através do Forum da API da BibleSearch.

Quais as Traduções disponíveis?

Actualmente só temos condições de disponibilizar as traduções listadas em baixo. Queremos disponibilizar novas traduções quanto possivel, mas primeiramente temos de ter a participação dos vários Editores que as publicam. Se necessitar de outra informação á qual queira ter acesso, contacte-nos quer via e-mail ou através do forums e tudo faremos para cooperar consigo!

  • Amplified Bible (AMP)
  • Beibl Cymraeg Newydd (Argraffiad Diwygiedig) (BCN)
  • Beibl.net (BNET)
  • Contemporary English Version (CEV)
  • Contemporary English Version UK (CEVUK)
  • Eadar-theangachadh Ur (NGT)
  • English Standard Version (ESV)
  • Good News Translation (GNT)
  • Good News Bible UK (GNB)
  • King James Version 1954/2011 (KJV)
  • King James Version - American (KJVA)
  • New American Standard Bible (NASB)
  • Reina-Valera 1960 (RVR)
  • Traduccion En Lenguaje Actual (TLA)
  • William Morgan Welsh Bible (BWM)

Porque não exitem outras Traduções da Bíblia ?

As Traduções das Escrituras existentes são propriedade intelectual de vários Editores e de proprietários de licença. Para dar acesso a uma Tradução através da nossa API, primeiramente necessitamos de ter uma permissão especial dos vários Editores. Se necessitar de acesso a uma nova Tradução, a maneira mais rápida para o fazer é falar e pedir permissão para tal através do nosso BibleSearch API Forum. Se nos informar daquilo que realmente deseja, podemos contactar os Editores e fazer o nosso melhor para que tal aconteça.

Para ajudar a criar confiança junto dos Editores e dos proprietários de licenças, utilizamos o Sistema de Gestão Fair Use na nossa API. Isso nos ajuda a fornecer uma camada extra de dados sobre o conteúdo das Escrituras que está sendo usado pelos utilizadores da API e, finalmente, pelos utilizadores finais das suas aplicações. Queremos enfatizar a transparência com a forma como o conteúdo das Escrituras é usado através de nossa API, mostrando aos Editores e proprietários de IP que protejemos os seus conteúdos e que garantimos a integridade das Escrituras.

O que é o Sistema de Gestão Fair Use?

O Sistema de Gestão Fair Use ajuda-nos a definir a maneira de como os conteúdos das Escrituras podem ser usados através da nossa API. Para o usar, deverá incluir um pequeno texto com código JavaScript no local do seu site onde quer exibir o resultado de uma chamada à API. A API retornará sempre o código JavaScript correto a ser utilizado para a chamada que efectuou. Basta adicioná-lo ao seu site.

Porque é requerido o uso do Sistema de Gestão Fair Use?

O Sistema de Gestão Fair Use fornece informações aos Editores das Escrituras de como os seus conteúdos estão sendo usados. Por outro lado, o Sistema ao adicionar mais traduções da Escrituras à API, demonstra assim a um Editor, o alcance da mesma. O Sistema também nos fornece valiosas informações que nos podem ajudar a alocar novos recursos de desenvolvimento, garantindo assim a expansão da API ao incluir esses recursos e informações que serão importantes para os utilizadores da API.

Que implicações tem o Sistema de Gestão Fair nas minhas aplicações?

O Sistema de Gestão Fair Use (FUMS) terá um impacto mínimo na sua aplicação. Nós otimizámos o nosso código e o JavaScript que lhe é entregue afim de garantir que os visitantes do seu site não sejam afetados pelo seu uso. Nenhuma informação pessoal tida como identificável será utilizada pelo FUMS. Além disso, à medida que formos a melhorarando as funcionalidades do FUMS, terá oportunidade de aceder a Estatisticas avançadas que lhe mostrarão como os conteúdos disponibilizados pela API no seu site estão sendo usados pelos seus visitantes.

Posso armazenar conteúdos?

Pode armazenar conteúdos em cache, mas pedimos-lhe que os limite a menos de http://support.bibles.org/categories/11919-biblesearch-api versículos. Recomendamos igualmente que limpe a cache a cada 14 dias ou menos. Os nossos conteúdos estão sendo continuamente melhorados, actualizados e acessíveis para si. Não é uma boa ideia guardar informação em cache por longos periodos de tempo. Queremos-lhe disponibilizar os conteúdos das Escrituras o mais actualizados possível.

Quantos pedidos posso efectuar por dia ? Exite algum limite ?

Sim, existe um limite. Só poderá realizar 5,000 pesquisas por dia. Se está construindo uma aplicação que ultrapasse o limite de consultas por dia, entre em contato conosco via e-mail ou pelo forum para que o possamos ajudar no sentido de ir ao encontro das suas necessidades. Queremos proporcionar-lhe o acesso aos conteúdos das Escrituras mas também necessitamos de proteger os nossos servidores.

Posso pedir permissão para exceder o limite máximo de pedidos ?

Estamos totalmente abertos a essa possibilidade. Mande-nos um e-mail para o endereço support@bibles.org colocando a palavra API no Assunto e dando-nos informações detalhadas sobre a sua aplicação e de que tipos de acesso necessita. Estaremos trabalhando consigo e atendendo às suas necessidades.

O que fazer para utilizar a API?

Para começar a utilizar a nossa API, sugerimos-lhe que primeiramente leia a documentação completa afim de se informar acerca dos recursos e limitações da mesma. Se necessitar de mais ajuda, aceda ao Forum da API da BibleSearch afim de pedir ajuda à comunidade. Lemos o fórum diariamente e respondemos a perguntas e a pedidos de solução de problemas. Se necessitar de ajuda imediata, envie-nos um pedido através do forum e nós entraremos em contato consigo o mais breve possível.

Tenho que incluir os Direitos do Autor sempre que utilizar uma determinada Tradução da Bíblia ?

Sim. É importante dar confiança às Editoras que detêm os direitos da Tradução dos conteúdos da Escritura usados. Pedimos-lhe que inclua as informações de Copyright em todos os conteúdos das Escrituras que exibir.

Como posso aceder à minha Tradução através da API?

Se é proprietário de alguma editora ou de Propriedade Intelectual e desejaria ver a sua tradução da Bíblia disponibilizada na BibleSearch e através da API, gostariamos que entrasse em contacto connosco. Envie-nos um e-mail para o endereço support@bibles.org

O que fazer se uma questão minha não se encontra respondida aqui ?

Através do nosso forum pode ter acesso a artigos colocados pela nossa equipa de desenvolvimento e a contribuições e questões colocadas por outros membros. Se não encontrar o que está procurando e se necessitar de ajuda imediata, envie-nos um e-mail para o endereço support@bibles.org escrevendo a palavra API no Assunto.