Developer Tools: API

Application Programming Interface (API)

BibleSearch Application Programming Interface (API)는 모든 개발자가 비상업적 용도로 성서 컨텐츠와 텍스트를 웹사이트 또는 앱으로 포함시킬 수 있도록 허용합니다. 개발자가 아니고 성서 컨텐츠 또는 BibleSearch를 웹사이트에 포함시키고자 할 때는이곳에서 제공하는 도구들을 확인해보시기 바랍니다. 개발자의 경우, BibleSearch API는 REST을 기반으로 하는 API이며, 이것과 관련한 전체 문건은 여기서 읽어보실 수 있습니다.

BibleSearch API를 어떻게 활용할 수 있는지 이해하려면 다음의 FAQ를 읽어보시기 바랍니다. 질문이 있는 경우 API 포럼을 방문하여 자유롭게 질문을 올려주시기 바랍니다. 이메일로 연락할 경우에는 이메일 제목란에 API를 입력하고, support@bibles.org로 이메일을 보내주시기 바랍니다.

어떻게 접속하나요?

API에 접속하려면, BibleSearch 사용자로 등록하셔야 하며, 고유의 API 토큰을 이곳에서 신청하여 활성화시킨 상태여야 합니다. API 토큰이 발행되면, API에 요청을 보내서 컨텐츠를 받을 수 있습니다. 기억해야 할 것은 모든 요청을 보낼 때에는 이 API 토큰을 포함시켜야 합니다. 귀하의 API 토큰은 귀하의 고유한 것으로, 보안을 유지하고 다른 사람과 공유하지 마시기 바랍니다!

데이터를 어떻게 사용할 수 있나요?

귀하는 API로부터 받은 성서 컨텐츠를 상업적인 용도 또는 비합적이거나, 노출이 심하거나 비도덕적이거나 다른 사람 또는 성서 자체를 공격하거나 경멸하는 내용의 앱에는 사용할 수 없습니다. 원칙적으로 상식을 지켜주시기 바랍니다. 성서의 의미 또는 성서를 해석하는 방식을 변질시키지 말아야 합니다.

상업적 용도로 이 컨텐츠를 사용하고자 하는 경우, 이메일 제목란에 API를 입력하고, support@bibles.org로 이메일을 보내서 구체적인 승인을 받아야 합니다. 그리고, 한 번에 500개의 연속 절만을 띄워야 하며, 보여주는 성서 컨텐츠와 함께 사용하는 역본에 대한 저작권 정보를 항상 포함시켜야 합니다. 이곳에서 API 이용약관 전문을 읽어보실 수 있습니다.

어떠한 유형의 어플리케이션을 만들 수 있나요?

위에서 명시된 것과 같이 성서 컨텐츠를 비상업적인 용도와 성서 본문의 온전함을 존중하는 긍정적인 방식으로 사용하는 경우에는 귀하가 의도하는 모든 것을 만들 수 있습니다. 우리는 언제나 개발자가 창조해내는 것들에 대해 깊은 관심을 갖고 있습니다. 그러므로 여러분이 만든 개발품들을 우리와 BibleSearch API 포럼 커뮤니티에서 나눠주시기 바랍니다.

어떤 역본이 제공되나요?

현재 아래 목록의 역본만 제공하고 있습니다. 가능한 최대한의 역본을 제공해드리고 싶지만 여러 출판사들이 이 프로젝트에 동참해야 합니다. 여러분이 이곳에서 꼭 제공했으면 하는 역본이 있으면 이메일이나 포럼에서 알려주시기 바랍니다. 여러분을 돕기 위해 최선을 다하겠습니다.

View Available API Versions

왜 더 많은 역본이 제공되지 않나요?

성서 역본은 여러 출판사와 저작권자의 지적 재산입니다. API를 통해서 역번을 접근할 수 있도록 하기 위해서는 먼저 이들 출판사들로부터 특별 허락을 받아야 합니다. 만약 귀하가 찾는 것이 있으면 BibleSearch API 포럼에서 필요한 사항을 알리고 요청하는 것입니다. 이를 통해서 우리는 해당 출판사를 접촉하고, 자료를 제공할 수 있도록 최선을 다할 수 있습니다.

출판사들과 지적 재산권을 보유한 이들과의 신뢰를 쌓기 위해서 우리는 API 내에 Fair Use Management System (공정 사용 관리 시스템)을 구축하였습니다. 이는 성서 컨텐츠가 API 사용자, 궁극적으로는 여러분이 개발한 앱 사용자에 의해 어떻게 사용되고 있는지 제공하는 별도의 데이터를 제공하는데 도움을 줍니다. 우리는 API를 통해 성서 컨텐츠가 어떻게 사용되고 있는지를 정확하게 보여줄 수 있도록 투명성을 제고하기 위하여 모든 노력을 함으로써 출판사들과 지적 재산권자들에게 우리가 그들의 컨텐츠를 보호하고 있으며, 성서의 온전성이 보존되도록 하고 있음을 보여주려고 합니다.

공정 사용 관리 시스템이란 무엇인가요?

공정 사용 관리 시스템(Fair Use Management System)은 성서 컨텐츠가 API에서 어떻게 사용되는지 기록하는데 도움을 줍니다. 이를 사용하려면 여러분의 웹사이트에 API 요청 결과로 보여주는 내용과 함께 작은 추가적인 자바스크립트 코드 토막을 포함합니다. API는 항상 여러분이 한 요청에 대해 사용할 정확한 자바스크립트를 제공하므로 여러분의 웹사이트에 단순히 추가하기만 하면 됩니다.

왜 공정 사용 관리 시스템을 사용하도록 요구하나요?

공정 사용 관리 시스템은 성서를 출판하는 이들에게 정보를 제공하고, 그들의 컨텐츠가 어떻게 사용되는지를 보여줍니다. 이 과정을 통해 API가 출판하는 이들에게 API를 허용함으로써 얼마나 더 많은 이들에게 성서를 전할 수 있는지를 보여줄 수 있게 됨에 따라 더 많은 성서 역본들을 추가할 수 있도록 할 것입니다. 또한 API 사용자들에게 중요한 기능과 데이터를 포함하도록 API를 확장시켜나갈 수 있도록 개발에 필요한 자원을 잘 분배할 수 있도록 하는 귀중한 정보를 제공합니다.

공정 사용 관리 시스템이 내 어플리케이션에 어떠한 영향을 주나요?

공정 사용 관리 시스템(Fair Use Management System)은 여러분의 어플리케이션에 최소한의 영향을 줍니다. 코드와 자바 스크립트 전달을 최적화해서 여러분의 방문객들이 영향을 받지 않도록 하였습니다. 공정 사용 관리 시스템은 어떠한 개인 신상을 파악할 수 있는 정보를 사용하지 않습니다. 그리고 공정 사용 관리 시스템의 기능을 만들어나가면서 여러분은 여러분 사이트에서 제공하는 API 데이터를 사용자들이 어떻게 사용하고 있는지를 보여주는 고급 통계 정보에 접근할 수 있습니다.

데이터 캐슁을 해도 되나요?

데이터를 캐쉬할 수는 있지만 http://support.bibles.org/categories/11919-biblesearch-api 의 절 수보다는 적도록 제한하기를 요청합니다. 또한 데이터 구조를 지속적으로 업데이트하고 접근성을 계속 향상시키고 있기 때문에 14일 또는 보다 짧은 주기로 캐쉬한 것을 제거하기를 권장합니다. 이를 고려한다면 오랜 기간 동안 캐쉬한 데이터를 오래 보관하는 것은 좋은 생각이 아닙니다. 왜냐하면 우리는 여러분이 가장 업데이트된 성서 컨텐츠를 갖고 있길 원하기 때문입니다.

하루에 요청을 몇 번 할 수 있나요? 대역폭 제한(rate limit)이 있나요?

네, 기본으로 설정된 대역폭 제한 값이 있습니다. 하루에 5,000 건의 쿼리만 수행할 수 있습니다. 하루에 이보다 많은 쿼리를 필요로 하는 대규모 어플리케이션을 구축하고 있다면 이메일 또는 포럼으로 연락 주시면 여러분의 필요를 충족시킬 수 있는 방법을 찾아보도록 하겠습니다. 궁극적으로 우리는 필요로 하는 성서 컨텐츠로의 접근은 허용하면서 동시에 서버 보호를 수행하고자 합니다.

대역폭 제한 초과를 허가받을 수 있는지 요청해도 되나요?

그 가능성에 대해서는 열린 입장을 취하고 있습니다. 이메일 제목란에 API를 입력하고, support@bibles.org로 이메일을 작성하시고, 작업 중인 어플리케이션과 어떻게 접근하기를 희망하는지를 알려주시기 바랍니다. 여러분과 함께 작업하는 것을 환영하며, 필요가 충족될 수 있도록 돕겠습니다.

API를 어떻게 사용하나요?

API 사용에 앞서, 전체 문건을 읽어서 현재 제공하는 API가 어떠한 기능을 제공하고 어떠한 제한점을 가지고 있는지 살펴보길 권장합니다. 개발 작업 중에 어려움에 봉착하거나 해결방법이 모호한 경우 BibleSearch API 포럼에 들러서 포럼 참석자들에게 도움을 요청하기 바랍니다. 우리는 매일 포럼 포스트를 읽고 있으며, 올려주신 질문이나 문제 해결에 대응할 것입니다. 즉각적인 도움을 필요로 하는 경우, 포럼에서 ticket request를 제출하면 최대한 빨리 응대하겠습니다.

보여주는 각 역본에 대한 저작권을 보여줘야 하나요?

네. 특정 역본의 성서 컨텐츠에 대한 권리를 소유하고 있는 출판사들에 대한 언급을 해주는 것은 중요합니다. 그렇기 때문에 여러분이 보여주는 모든 성서에 대한 저작권 정보를 포함시켜야 합니다.

내 역본을 어떻게 API에 포함시킬 수 있나요?

여러분이 출판사거나 지적 재산권을 소유하고 있어서 Bible Search와 API를 통해서 여러분의 성경 역본을 제공하고자 한다면 꼭 연락 주시기 바랍니다. support@bibles.org로 이메일 보내주시기 바랍니다.

내 질문에 대한 답이 없는 경우에는 어떻게 하나요?

여러분이 커뮤니티가 한 질문과 답변은 물론 우리 개발팀에서 작성한 글을 탐색할 수 있도록 포럼을 운영하고 있습니다. 찾고자 하는 내용이 없고, 즉각적인 도움을 필요로 하는 경우, 이메일 제목란에 API를 입력하고, support@bibles.org로 이메일을 보내주시기 바랍니다.