कंटेंट एंडपॉइंट
कंटेंट मॉड्यूल वेबसाइट के पेज, सेक्शन, एलिमेंट, ब्लॉक, ब्लॉग पोस्ट, रीडायरेक्ट, सरमन, प्लेलिस्ट, स्ट्रीमिंग सेवाएँ, इवेंट, क्यूरेटेड कैलेंडर, फ़ाइलें, गैलरी, बाइबल अनुवाद और वचन खोज, गीत, अरेंजमेंट, ग्लोबल स्टाइल, स्टॉक फ़ोटो और सेटिंग्स को प्रबंधित करता है। यह API का सबसे बड़ा मॉड्यूल है और सभी ChurchApps एप्लिकेशन में CMS, मीडिया/स्ट्रीमिंग, वर्शिप प्लानिंग और बाइबल सुविधाओं को सशक्त बनाता है।
बेस पाथ: /content
पेज
बेस पाथ: /content/pages
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:churchId/tree?url=&id= | सार्वजनिक | — | URL या ID द्वारा पूरा पेज ट्री (सेक्शन, एलिमेंट, ब्लॉक) लोड करें। URL से लाने पर आंतरिक ID हटा दी जाती हैं। URL-आधारित फ़ेच pages.visibility लागू करते हैं — सीमित पेज { restricted: true, visibility } लौटाता है, जब तक (वैकल्पिक) JWT शर्त पूरी न करे |
| GET | /public/:churchId | सार्वजनिक | — | सार्वजनिक पेज सूचीबद्ध करें (url, title, metaDescription); केवल visibility = everyone वाले |
| GET | /:id | JWT | — | ID द्वारा पेज प्राप्त करें |
| GET | / | JWT | — | चर्च के सभी पेज सूचीबद्ध करें |
| POST | /duplicate/:id | JWT | Content.Edit | सभी सेक्शन और एलिमेंट के साथ पेज की प्रतिलिपि बनाएँ |
| POST | /temp/ai | JWT | Content.Edit | AI द्वारा बनाया गया पेज सहेजें (एक कॉल में पेज, सेक्शन और एलिमेंट) |
| POST | /importTree | JWT | Content.Edit | नेस्टेड ट्री से पेज बनाएँ (title, url, sections[].elements[]…)। हमेशा कॉलर के चर्च के अंदर डालता है; बॉडी के ID अनदेखे किए जाते हैं। पंक्तियों में उनके column चाइल्ड होने चाहिए। अधिकतम 30 सेक्शन / 500 एलिमेंट |
| POST | / | JWT | Content.Edit | पेज बनाएँ या अपडेट करें (बैच में) |
| DELETE | /:id | JWT | Content.Edit | पेज हटाएँ |
उदाहरण: पेज ट्री लोड करना
GET /content/pages/abc-church-id/tree?url=/about
{
"name": "About",
"url": "/about",
"sections": [
{
"background": "#FFFFFF",
"textColor": "dark",
"elements": [
{ "elementType": "textWithPhoto", "answers": { "text": "Welcome" } }
]
}
]
}
सेक्शन
बेस पाथ: /content/sections
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा सेक्शन प्राप्त करें |
| POST | /duplicate/:id?convertToBlock= | JWT | Content.Edit | सेक्शन की प्रतिलिपि बनाएँ या उसे पुन: उपयोग योग्य ब्लॉक में बदलें |
| POST | / | JWT | Content.Edit | सेक्शन बनाएँ या अपडेट करें (बैच में)। क्रम अपने-आप अपडेट होता है |
| DELETE | /:id | JWT | Content.Edit | सेक्शन हटाएँ (क्रम अपने-आप अपडेट होता है) |
एलिमेंट
बेस पाथ: /content/elements
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा एलिमेंट प्राप्त करें |
| POST | /duplicate/:id | JWT | Content.Edit | सभी चाइल्ड के साथ एलिमेंट की प्रतिलिपि बनाएँ |
| POST | / | JWT | Content.Edit | एलिमेंट बनाएँ या अपडेट करें (बैच में)। रो के कॉलम और कैरोसेल स्लाइड अपने-आप प्रबंधित होते हैं |
| DELETE | /:id | JWT | Content.Edit | एलिमेंट हटाएँ |
ब्लॉक
बेस पाथ: /content/blocks
बेस क्लास से मानक CRUD (GET /:id, GET /, POST /, DELETE /:id) का विस्तार करता है, जिसमें लिखने के लिए Content.Edit अनुमति लगती है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा ब्लॉक प्राप्त करें |
| GET | / | JWT | — | सभी ब्लॉक सूचीबद्ध करें |
| GET | /:churchId/tree/:id | सार्वजनिक | — | सेक्शन और एलिमेंट के साथ पूरा ब्लॉक ट्री लोड करें |
| GET | /blockType/:blockType | JWT | — | प्रकार के अनुसार ब्लॉक लोड करें (जैसे footerBlock, elementBlock) |
| GET | /public/footer/:churchId | सार्वजनिक | — | किसी चर्च के लिए फ़ुटर ब्लॉक ट्री लोड करें |
| POST | / | JWT | Content.Edit | ब्लॉक बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | Content.Edit | ब्लॉक हटाएँ |
लिंक
बेस पाथ: /content/links
बेस क्लास से मानक CRUD (GET /:id, GET /, POST /, DELETE /:id) का विस्तार करता है, जिसमें लिखने के लिए Content.Edit अनुमति लगती है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा लिंक प्राप्त करें |
| GET | / | JWT | — | सभी लिंक सूचीबद्ध करें। वैकल्पिक ?category= फ़िल्टर। सहेजने के बाद अपने-आप क्रमबद्ध |
| GET | /church/:churchId/filtered?category= | JWT | — | दृश्यता के अनुसार फ़िल्टर किए गए लिंक लोड करें (everyone, visitors, members, staff, groups) |
| GET | /church/:churchId?category= | सार्वजनिक | — | श्रेणी के अनुसार किसी चर्च के लिंक लोड करें (सार्वजनिक) |
| POST | / | JWT | Content.Edit | लिंक बनाएँ या अपडेट करें (बैच में)। श्रेणी के अनुसार अपने-आप क्रमबद्ध |
| DELETE | /:id | JWT | Content.Edit | लिंक हटाएँ |
ग्लोबल स्टाइल
बेस पाथ: /content/globalStyles
बेस क्लास से मानक CRUD (POST /, DELETE /:id) का विस्तार करता है, जिसमें लिखने के लिए Content.Edit अनुमति लगती है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /church/:churchId | सार्वजनिक | — | किसी चर्च के ग्लोबल स्टाइल लोड करें (कुछ सेट न होने पर डिफ़ॉल्ट लौटाता है) |
| GET | / | JWT | — | प्रमाणित चर्च के ग्लोबल स्टाइल लोड करें |
| POST | / | JWT | Content.Edit | ग्लोबल स्टाइल बनाएँ या अपडेट करें |
| DELETE | /:id | JWT | Content.Edit | ग्लोबल स्टाइल हटाएँ |
पेज इतिहास
बेस पाथ: /content/pageHistory
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /page/:pageId | JWT | Content.Edit | किसी पेज की इतिहास प्रविष्टियाँ सूचीबद्ध करें |
| GET | /block/:blockId | JWT | Content.Edit | किसी ब्लॉक की इतिहास प्रविष्टियाँ सूचीबद्ध करें |
| GET | /:id | JWT | Content.Edit | ID द्वारा इतिहास प्रविष्टि प्राप्त करें |
| POST | / | JWT | Content.Edit | पेज/ब्लॉक का स्नैपशॉट सहेजें। समय-समय पर 30 दिन से पुरानी प्रविष्टियाँ साफ़ करता है |
| POST | /restore/:id | JWT | Content.Edit | इतिहास स्नैपशॉट से पेज/ब्लॉक पुनर्स्थापित करें (मौजूदा सामग्री हटाकर स्नैपशॉट से दोबारा बनाता है) |
| POST | /restoreSnapshot | JWT | Content.Edit | इनलाइन स्नैपशॉट ऑब्जेक्ट से पुनर्स्थापित करें। बॉडी: { pageId, blockId, snapshot } |
पोस्ट (ब्लॉग)
बेस पाथ: /content/posts
ब्लॉग पोस्ट स्वतंत्र पंक्तियाँ हैं: title, slug (हर चर्च में अद्वितीय), excerpt, content (markdown बॉडी), authorId, photoUrl, publishDate, category, और tags। publishDate सेट होने और अतीत में होने पर ही पोस्ट प्रकाशित मानी जाती है। पढ़ने वाले एंडपॉइंट हर पोस्ट में authorId से हल किया गया authorName जोड़ते हैं। देखें वेबसाइट बिल्डर आर्किटेक्चर।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /public/:churchId?category=&tag=&page=&pageSize= | सार्वजनिक | — | प्रकाशित पोस्ट सूचीबद्ध करें, पेजिनेटेड (प्रति पेज अधिकतम 50) |
| GET | /public/:churchId/categories | सार्वजनिक | — | प्रकाशित पोस्ट की अलग-अलग श्रेणियाँ |
| GET | /public/:churchId/slug/:slug | सार्वजनिक | — | slug द्वारा प्रकाशित पोस्ट प्राप्त करें |
| GET | /rss/:churchId?siteUrl= | सार्वजनिक | — | प्रकाशित पोस्ट का RSS 2.0 फ़ीड (लिंक {siteUrl}/blog/{slug} के रूप में बनते हैं) |
| GET | /:id | JWT | — | ID द्वारा पोस्ट प्राप्त करें |
| GET | / | JWT | — | चर्च की सभी पोस्ट सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | पोस्ट बनाएँ या अपडेट करें (बैच में) |
| DELETE | /:id | JWT | Content.Edit | पोस्ट हटाएँ |
रीडायरेक्ट
बेस पाथ: /content/redirects
हर चर्च के लिए URL रीडायरेक्ट (fromPath → toPath), प्रति चर्च अधिकतम 200। पाथ सामान्यीकृत होते हैं (छोटे अक्षर, आरंभ में स्लैश, अंत में स्लैश नहीं) और प्रति चर्च fromPath अद्वितीय होता है। B1App संभावित 404 पर इन्हें हल करता है और HTTP 308 जारी करता है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /public/:churchId?path= | सार्वजनिक | — | पाथ हल करें (path न होने पर सभी रीडायरेक्ट सूचीबद्ध करें) |
| GET | /:id | JWT | — | ID द्वारा रीडायरेक्ट प्राप्त करें |
| GET | / | JWT | — | चर्च के सभी रीडायरेक्ट सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | रीडायरेक्ट बनाएँ या अपडेट करें। fromPath = toPath अस्वीकार करता है और 200-पंक्ति सीमा लागू करता है |
| DELETE | /:id | JWT | Content.Edit | रीडायरेक्ट हटाएँ |
सरमन
बेस पाथ: /content/sermons
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /public/freeshowSample | JWT | — | FreeShow प्लेलिस्ट संरचना का नमूना प्राप्त करें |
| GET | /public/tvWrapper/:churchId | JWT | — | सरमन, पाठ और FreeShow स्रोतों के साथ TV ऐप रैपर प्राप्त करें |
| GET | /public/tvFeed/:churchId/:sermonId | सार्वजनिक | — | एक सरमन को TV फ़ीड प्लेलिस्ट के रूप में प्राप्त करें |
| GET | /public/tvFeed/:churchId | सार्वजनिक | — | सभी सार्वजनिक प्लेलिस्ट/सरमन को TV फ़ीड के रूप में प्राप्त करें |
| GET | /public/:churchId | सार्वजनिक | — | किसी चर्च के सभी सार्वजनिक सरमन सूचीबद्ध करें |
| GET | /timeline?sermonIds= | JWT | — | सरमन के लिए टाइमलाइन डेटा लोड करें |
| GET | /lookup?videoType=&videoData= | सार्वजनिक | — | YouTube या Vimeo से सरमन की मेटाडेटा खोजें |
| GET | /socialSuggestions?youtubeVideoId= | JWT | — | सरमन के सबटाइटल से AI सोशल मीडिया पोस्ट सुझाव बनाएँ |
| GET | /outline?url=&title=&author= | JWT | — | URL से AI पाठ रूपरेखा बनाएँ |
| GET | /youtubeImport/:channelId | JWT | — | YouTube चैनल से वीडियो आयात करें। YouTube के सर्च API के शीर्षक और विवरण में आने वाले HTML एंटिटी (जैसे & और ') डिकोड किए जाते हैं |
| GET | /vimeoImport/:channelId | JWT | — | Vimeo चैनल से वीडियो आयात करें |
| GET | /:id | JWT | — | ID द्वारा सरमन प्राप्त करें |
| GET | / | JWT | — | सभी सरमन सूचीबद्ध करें |
| POST | / | JWT | StreamingServices.Edit | सरमन बनाएँ या अपडेट करें। सरणी या एकल सरमन ऑब्जेक्ट स्वीकार करता है (हमेशा सरणी लौटाता है); खाली बॉडी पर 400 लौटता है। base64 थंबनेल अपलोड समर्थित |
| DELETE | /:id | JWT | StreamingServices.Edit | सरमन हटाएँ |
उदाहरण: YouTube सरमन खोजना
GET /content/sermons/lookup?videoType=youtube&videoData=dQw4w9WgXcQ
{
"title": "Sunday Service - Faith in Action",
"description": "Pastor John speaks about faith...",
"thumbnail": "https://img.youtube.com/vi/dQw4w9WgXcQ/default.jpg",
"duration": 2400,
"publishDate": "2025-01-15T10:00:00Z"
}
प्लेलिस्ट
बेस पाथ: /content/playlists
बेस क्लास से मानक CRUD (GET /:id, GET /, DELETE /:id) का विस्तार करता है, जिसमें लिखने के लिए StreamingServices.Edit अनुमति लगती है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा प्लेलिस्ट प्राप्त करें |
| GET | / | JWT | — | सभी प्लेलिस्ट सूचीबद्ध करें |
| GET | /public/:churchId | सार्वजनिक | — | किसी चर्च की सभी सार्वजनिक प्लेलिस्ट सूचीबद्ध करें |
| POST | / | JWT | StreamingServices.Edit | प्लेलिस्ट बनाएँ या अपडेट करें (बैच में, base64 थंबनेल अपलोड समर्थित) |
| DELETE | /:id | JWT | StreamingServices.Edit | प्लेलिस्ट हटाएँ |
स्ट्रीमिंग सेवाएँ
बेस पाथ: /content/streamingServices
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id/hostChat | JWT | Chat.Host | किसी सेवा के लिए एन्क्रिप्टेड होस्ट चैट रूम ID प्राप्त करें |
| GET | / | JWT | — | सभी स्ट्रीमिंग सेवाएँ सूचीबद्ध करें। समाप्त हुई गैर-आवर्ती सेवाएँ अपने-आप हटाता है और आवर्ती सेवाओं को आगे बढ़ाता है |
| POST | / | JWT | StreamingServices.Edit | स्ट्रीमिंग सेवाएँ बनाएँ या अपडेट करें (बैच में) |
| DELETE | /:id | JWT | StreamingServices.Edit | स्ट्रीमिंग सेवा हटाएँ (ब्लॉक किए गए IP भी साफ़ करता है) |
इवेंट
बेस पाथ: /content/events
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /timeline/group/:groupId?eventIds= | JWT | — | किसी समूह के टाइमलाइन इवेंट लोड करें (अपवाद तिथियाँ शामिल, ताकि हटाई गई पुनरावृत्तियाँ छोड़ी जा सकें) |
| GET | /timeline?eventIds= | JWT | — | वर्तमान उपयोगकर्ता के समूहों के टाइमलाइन इवेंट लोड करें (अपवाद तिथियाँ शामिल) |
| GET | /subscribe?churchId=&groupId=&curatedCalendarId= | सार्वजनिक | — | इवेंट के लिए ICS कैलेंडर फ़ीड की सदस्यता लें |
| GET | /group/:groupId | JWT | — | किसी समूह के इवेंट प्राप्त करें (अपवाद तिथियाँ शामिल) |
| GET | /public/group/:churchId/:groupId | सार्वजनिक | — | किसी समूह के सार्वजनिक इवेंट प्राप्त करें |
| GET | /public/:churchId/:id | सार्वजनिक | — | सार्वजनिक पेज के लिए एक इवेंट प्राप्त करें, roomNames के साथ (अस्वीकृत न होने वाली बुकिंग के कमरे)। लंबित या अस्वीकृत इवेंट और पंजीकरण न लेने वाले निजी इवेंट के लिए null लौटाता है |
| GET | /public/:churchId/:id/ical | सार्वजनिक | — | उस एक इवेंट को .ics फ़ाइल के रूप में डाउनलोड करें (text/calendar, अपवाद तिथियाँ लागू)। उन्हीं नियमों से इवेंट छिपा होने पर 404 |
| GET | /:id | JWT | — | ID द्वारा इवेंट प्राप्त करें |
| POST | / | JWT | — | इवेंट बनाएँ या अपडेट करें (बैच में) |
| DELETE | /:id | JWT | Content.Edit, Calendars.Admin, या समूह लीडर | इवेंट और उसकी बुकिंग हटाएँ। इवेंट के समूह के लीडर इसे हटा सकते हैं, और अनुरोधकर्ता अपना लंबित अनुरोध वापस ले सकता है |
इवेंट रिकॉर्ड में photoUrl (सार्वजनिक इवेंट पेज और आगामी इवेंट टाइलों पर दिखने वाली 16:9 इवेंट फ़ोटो), tags (कॉमा से अलग, वेबसाइट Calendar एलिमेंट के टैग फ़िल्टर द्वारा उपयोग), और notesViewRole / notesPostRole (null होने पर staff, या leaders, या members) शामिल हैं। ये इवेंट की eventNote बातचीत तक पहुँच नियंत्रित करते हैं — देखें समूह और इवेंट नोट्स पहुँच नियंत्रण। सार्वजनिक क्यूरेटेड-इवेंट प्रतिक्रियाओं में भी हर इवेंट का photoUrl और tags होता है।
इवेंट अपवाद
बेस पाथ: /content/eventExceptions
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा इवेंट अपवाद प्राप्त करें |
| POST | / | JWT | Content.Edit, Calendars.Admin, या समूह लीडर | इवेंट अपवाद बनाएँ या अपडेट करें (बैच में)। लीडर केवल अपने समूहों के इवेंट के लिए अपवाद जोड़ सकते हैं |
| DELETE | /:id | JWT | Content.Edit, Calendars.Admin, या समूह लीडर | इवेंट अपवाद हटाएँ |
क्यूरेटेड कैलेंडर
बेस पाथ: /content/curatedCalendars
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा क्यूरेटेड कैलेंडर प्राप्त करें |
| GET | / | JWT | — | सभी क्यूरेटेड कैलेंडर सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | क्यूरेटेड कैलेंडर बनाएँ या अपडेट करें (बैच में) |
| DELETE | /:id | JWT | Content.Edit | क्यूरेटेड कैलेंडर हटाएँ |
क्यूरेटेड इवेंट
बेस पाथ: /content/curatedEvents
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /calendar/:curatedCalendarId?withoutEvents | JWT | — | किसी कैलेंडर के क्यूरेटेड इवेंट प्राप्त करें (जब तक ?withoutEvents सेट न हो, इवेंट विवरण और अपवाद तिथियाँ शामिल) |
| GET | /public/calendar/:churchId/:curatedCalendarId | सार्वजनिक | — | किसी कैलेंडर के सार्वजनिक क्यूरेटेड इवेंट प्राप्त करें |
| GET | /:id | JWT | — | ID द्वारा क्यूरेटेड इवेंट प्राप्त करें |
| GET | / | JWT | — | सभी क्यूरेटेड इवेंट सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | क्यूरेटेड इवेंट बनाएँ या अपडेट करें। विशिष्ट समूह इवेंट जोड़ने के लिए eventIds सरणी समर्थित |
| DELETE | /:id | JWT | Content.Edit | क्यूरेटेड इवेंट हटाएँ |
| DELETE | /calendar/:curatedCalendarId/event/:eventId | JWT | Content.Edit | किसी क्यूरेटेड कैलेंडर से एक विशिष्ट इवेंट हटाएँ |
| DELETE | /calendar/:curatedCalendarId/group/:groupId | JWT | Content.Edit | किसी क्यूरेटेड कैलेंडर से किसी समूह के सभी इवेंट हटाएँ |
फ़ाइलें
बेस पाथ: /content/files
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:contentType/:contentId | JWT | — | कंटेंट प्रकार और कंटेंट ID के अनुसार फ़ाइलें प्राप्त करें |
| GET | / | JWT | — | चर्च वेबसाइट की सभी फ़ाइलें सूचीबद्ध करें |
| GET | /:id | JWT | — | ID द्वारा फ़ाइल प्राप्त करें |
| POST | / | JWT | Content.Edit* | फ़ाइलें अपलोड करें (base64)। *यदि उपयोगकर्ता contentId से मेल खाते समूह का सदस्य है तो भी अनुमति |
| POST | /postUrl | JWT | Content.Edit* | पूर्व-हस्ताक्षरित S3 अपलोड URL प्राप्त करें। *समूह सदस्यों के लिए भी अनुमति। प्रति कंटेंट आइटम अधिकतम 100MB |
| DELETE | /:id | JWT | Content.Edit* | फ़ाइल हटाएँ और स्टोरेज से निकालें। *समूह सदस्यों के लिए भी अनुमति |
गैलरी
बेस पाथ: /content/gallery
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /stock/:folder | सार्वजनिक | — | किसी फ़ोल्डर की स्टॉक फ़ोटो सूचीबद्ध करें |
| GET | /:folder | JWT | Content.Edit | किसी फ़ोल्डर की गैलरी छवियाँ सूचीबद्ध करें |
| POST | /requestUpload | JWT | Content.Edit | गैलरी छवि के लिए पूर्व-हस्ताक्षरित S3 अपलोड URL प्राप्त करें |
| DELETE | /:folder/:image | JWT | Content.Edit | गैलरी छवि हटाएँ |
बाइबल
बेस पाथ: /content/bibles
सभी बाइबल एंडपॉइंट सार्वजनिक हैं (प्रमाणीकरण आवश्यक नहीं)। डेटा बाहरी स्रोतों से लाया जाता है और स्थानीय रूप से कैश होता है। api.bible के अनुरोध 15 सेकंड में समय समाप्त होते हैं; समय समाप्त होने पर 504 लौटता है।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | / | सार्वजनिक | — | सभी बाइबल अनुवाद सूचीबद्ध करें (कैश खाली होने पर स्रोत से लाता है) |
| GET | /stats?startDate=&endDate= | सार्वजनिक | — | किसी तिथि सीमा के लिए बाइबल खोज के आँकड़े प्राप्त करें |
| GET | /availableTranslations/:source | सार्वजनिक | — | किसी स्रोत (जैसे api.bible) के उपलब्ध अनुवाद सूचीबद्ध करें |
| GET | /updateTranslations | सार्वजनिक | — | सभी स्रोतों के सभी अनुवाद सिंक करें |
| GET | /updateTranslations/:source | सार्वजनिक | — | किसी विशिष्ट स्रोत के अनुवाद सिंक करें |
| GET | /updateCopyrights | सार्वजनिक | — | जिन अनुवादों में कॉपीराइट जानकारी नहीं है, उनकी जानकारी अपडेट करें |
| GET | /:translationKey/updateCopyright | सार्वजनिक | — | किसी विशिष्ट अनुवाद का कॉपीराइट अपडेट करें |
| GET | /:translationKey/search?query=&limit= | सार्वजनिक | — | किसी अनुवाद में वचन खोजें |
| GET | /:translationKey/books | सार्वजनिक | — | किसी अनुवाद की पुस्तकें प्राप्त करें (स्थानीय रूप से कैश करता है) |
| GET | /:translationKey/:bookKey/chapters | सार्वजनिक | — | किसी पुस्तक के अध्याय प्राप्त करें (स्थानीय रूप से कैश करता है) |
| GET | /:translationKey/chapters/:chapterKey/verses | सार्वजनिक | — | किसी अध्याय के वचन प्राप्त करें (स्थानीय रूप से कैश करता है) |
| GET | /:translationKey/verses/:startVerseKey-:endVerseKey | सार्वजनिक | — | किसी सीमा का वचन पाठ प्राप्त करें। खोज लॉग होती है। लाइसेंसिंग के कारण कुछ अनुवाद कैशिंग छोड़ते हैं |
उदाहरण: वचन पाठ प्राप्त करना
GET /content/bibles/de4e12af7f28f599-02/verses/GEN.1.1-GEN.1.3
[
{ "verseKey": "GEN.1.1", "content": "In the beginning God created the heavens and the earth.", "bookKey": "GEN", "chapterNumber": 1, "verseNumber": 1 },
{ "verseKey": "GEN.1.2", "content": "Now the earth was formless and empty...", "bookKey": "GEN", "chapterNumber": 1, "verseNumber": 2 },
{ "verseKey": "GEN.1.3", "content": "And God said, \"Let there be light,\" and there was light.", "bookKey": "GEN", "chapterNumber": 1, "verseNumber": 3 }
]
गीत
बेस पाथ: /content/songs
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /search?q= | JWT | — | क्वेरी द्वारा गीत खोजें |
| GET | /:id | JWT | — | ID द्वारा गीत प्राप्त करें |
| GET | / | JWT | Content.Edit | सभी गीत सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | गीत बनाएँ या अपडेट करें (बैच में) |
| POST | /import | JWT | — | FreeShow से गीत आयात करें (बैच में) |
| DELETE | /:id | JWT | Content.Edit | गीत हटाएँ |
गीत विवरण
बेस पाथ: /content/songDetails
गीत विवरण वैश्विक हैं (चर्च-विशिष्ट नहीं)। ये विभिन्न चर्चों में साझा मानक गीत मेटाडेटा दर्शाते हैं।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा गीत विवरण प्राप्त करें (वैश्विक) |
| GET | / | JWT | — | चर्च के गीत विवरण सूचीबद्ध करें |
| POST | /create | JWT | — | PraiseCharts ID से गीत विवरण बनाएँ (पहले से बना हो तो मौजूदा लौटाता है)। PraiseCharts और MusicBrainz से मेटाडेटा अपने-आप लाता है |
| POST | / | JWT | — | गीत विवरण बनाएँ या अपडेट करें (बैच में) |
गीत विवरण लिंक
बेस पाथ: /content/songDetailLinks
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा गीत विवरण लिंक प्राप्त करें |
| GET | /songDetail/:songDetailId | JWT | — | किसी गीत विवरण के सभी लिंक प्राप्त करें |
| POST | / | JWT | — | गीत विवरण लिंक बनाएँ या अपडेट करें (बैच में)। लिंक होने पर MusicBrainz डेटा अपने-आप लाता है |
| DELETE | /:id | JWT | — | गीत विवरण लिंक हटाएँ |
अरेंजमेंट
बेस पाथ: /content/arrangements
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /:id | JWT | — | ID द्वारा अरेंजमेंट प्राप्त करें |
| GET | /song/:songId | JWT | Content.Edit | किसी गीत के अरेंजमेंट प्राप्त करें |
| GET | /songDetail/:songDetailId | JWT | Content.Edit | किसी गीत विवरण के अरेंजमेंट प्राप्त करें |
| GET | / | JWT | Content.Edit | सभी अरेंजमेंट सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | अरेंजमेंट बनाएँ या अपडेट करें (बैच में) |
| POST | /freeShow/missing | JWT | — | ऐसे FreeShow ID खोजें जो चर्च में मौजूद नहीं हैं। बॉडी: { freeShowIds: string[] } |
| DELETE | /:id | JWT | Content.Edit | अरेंजमेंट हटाएँ (उसकी कुंजियाँ भी हटाता है; कोई अरेंजमेंट न बचे तो गीत भी हटाता है) |
अरेंजमेंट कुंजियाँ
बेस पाथ: /content/arrangementKeys
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /presenter/:churchId/:id | सार्वजनिक | — | प्रस्तुतकर्ता दृश्य के लिए पूर्ण गीत डेटा के साथ अरेंजमेंट कुंजी प्राप्त करें |
| GET | /:id | JWT | — | ID द्वारा अरेंजमेंट कुंजी प्राप्त करें |
| GET | /arrangement/:arrangementId | JWT | Content.Edit | किसी अरेंजमेंट की कुंजियाँ प्राप्त करें |
| GET | / | JWT | Content.Edit | सभी अरेंजमेंट कुंजियाँ सूचीबद्ध करें |
| POST | / | JWT | Content.Edit | अरेंजमेंट कुंजियाँ बनाएँ या अपडेट करें (बैच में) |
| DELETE | /:id | JWT | Content.Edit | अरेंजमेंट कुंजी हटाएँ |
सेटिंग्स
बेस पाथ: /content/settings
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /my | JWT | — | वर्तमान उपयोगकर्ता की सेटिंग्स प्राप्त करें |
| GET | / | JWT | Settings.Edit | चर्च की सभी सेटिंग्स प्राप्त करें |
| GET | /public/:churchId | सार्वजनिक | — | किसी चर्च की सार्वजनिक सेटिंग्स प्राप्त करें (की-वैल्यू जोड़ों के रूप में) |
| POST | /my | JWT | — | उपयोगकर्ता-स्तरीय सेटिंग्स सहेजें (base64 छवि अपलोड समर्थित) |
| POST | / | JWT | Settings.Edit | चर्च-स्तरीय सेटिंग्स सहेजें (base64 छवि अपलोड समर्थित) |
| DELETE | /my/:id | JWT | — | उपयोगकर्ता सेटिंग हटाएँ |
पूर्वावलोकन
बेस पाथ: /content/preview
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /data/:key | सार्वजनिक | — | सबडोमेन कुंजी द्वारा किसी चर्च का स्ट्रीमिंग पूर्वावलोकन डेटा लोड करें (टैब, लिंक, सेवाएँ, सरमन) |
गैलरी (स्टॉक फ़ोटो)
बेस पाथ: /content/stock
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| POST | /search | सार्वजनिक | — | Pexels स्टॉक फ़ोटो खोजें। बॉडी: { term: "church" } |
PraiseCharts
बेस पाथ: /content/praiseCharts
वर्शिप गीत खोजने और शीट म्यूज़िक डाउनलोड के लिए PraiseCharts के साथ एकीकरण।
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| GET | /raw/:id | JWT | — | किसी गीत का मूल PraiseCharts डेटा प्राप्त करें |
| GET | /hasAccount | JWT | — | जाँचें कि उपयोगकर्ता का PraiseCharts खाता लिंक है या नहीं |
| GET | /search?q= | JWT | — | PraiseCharts कैटलॉग खोजें |
| GET | /products/:id?keys= | JWT | — | किसी गीत के उत्पाद प्राप्त करें (प्रमाणित होने पर लाइब्रेरी से, अन्यथा कैटलॉग से) |
| GET | /arrangement/raw/:id?keys= | JWT | — | लाइब्रेरी से मूल अरेंजमेंट डेटा प्राप्त करें |
| GET | /download?skus=&keys=&file_name= | JWT | — | PraiseCharts से फ़ाइल डाउनलोड करें (PDF या ZIP)। { redirectUrl } लौटाता है |
| GET | /authUrl?returnUrl= | सार्वजनिक | — | PraiseCharts के लिए OAuth प्राधिकरण URL प्राप्त करें |
| GET | /access?verifier=&token=&secret= | JWT | — | OAuth verifier को एक्सेस टोकन में बदलें और उपयोगकर्ता सेटिंग्स में सहेजें |
| GET | /library | JWT | — | उपयोगकर्ता की PraiseCharts लाइब्रेरी देखें |
सहायता
बेस पाथ: /content/support
| विधि | पाथ | प्रमाणीकरण | अनुमति | विवरण |
|---|---|---|---|---|
| POST | /createAudio | सार्वजनिक | — | AWS Polly से SSML को MP3 ऑडियो में बदलें। बॉडी: { ssml: "<speak>...</speak>" } |
संबंधित पेज
- वेबसाइट बिल्डर आर्किटेक्चर -- ऐप्स में पेज, सेक्शन, एलिमेंट, पोस्ट और रीडायरेक्ट कैसे एक-दूसरे से जुड़ते हैं
- सदस्यता एंडपॉइंट -- लोग, चर्च, समूह, भूमिकाएँ, अनुमतियाँ
- उपस्थिति एंडपॉइंट -- सेवा और विज़िट ट्रैकिंग
- प्रमाणीकरण और अनुमतियाँ -- लॉगिन प्रवाह, JWT, अनुमति मॉडल
- मॉड्यूल संरचना -- कोड व्यवस्था के पैटर्न