एंडपॉइंट संदर्भ
यह खंड ChurchApps API द्वारा उपलब्ध कराए गए सभी REST एंडपॉइंट का दस्तावेज़ है। प्रत्येक मॉड्यूल पृष्ठ में हर रूट की HTTP विधि, पथ, प्रमाणीकरण आवश्यकताएँ और आवश्यक अनुमतियाँ सूचीबद्ध हैं।
बेस URL
| वातावरण | URL |
|---|---|
| लोकल डेवलपमेंट | http://localhost:8084 |
| प्रोडक्शन | https://api.churchapps.org |
अनुरोध संबंधी परंपराएँ
- Content-Type: सभी अनुरोध और प्रतिक्रिया बॉडी
application/jsonका उपयोग करती हैं - मल्टी-टेनेंट: हर प्रमाणित अनुरोध JWT टोकन से निकाले गए
churchIdतक सीमित होता है — आप URL मेंchurchIdपास नहीं करते - बैच सेव: अधिकांश
POSTएंडपॉइंट ऑब्जेक्ट की एक सरणी स्वीकार करते हैं। API एक ही कॉल में नए रिकॉर्ड (बिनाidफ़ील्ड वाले) जोड़ता है और मौजूदा रिकॉर्ड (idफ़ील्ड वाले) अपडेट करता है - ID: सभी इकाई ID UUID हैं
उदाहरण: बैच सेव
POST /membership/people
Authorization: Bearer <token>
[
{ "firstName": "Jane", "lastName": "Doe" },
{ "id": "abc-123", "firstName": "John", "lastName": "Smith" }
]
पहला ऑब्जेक्ट नया बनाया जाता है; दूसरा अपडेट होता है (उसमें id है)।
प्रतिक्रिया प्रारूप
सफल प्रतिक्रियाएँ JSON लौटाती हैं — या तो एक ऑब्जेक्ट या एक सरणी। त्रुटि प्रतिक्रियाएँ मानक HTTP स्टेटस कोड का उपयोग करती हैं:
| कोड | अर्थ |
|---|---|
200 | सफल |
400 | खराब अनुरोध (सत्यापन त्रुटियाँ) |
401 | अनधिकृत (टोकन गायब/अमान्य या अपर्याप्त अनुमतियाँ) |
404 | नहीं मिला |
500 | सर्वर त्रुटि |
सत्यापन त्रुटियाँ इस प्रकार लौटती हैं:
{
"errors": [
{ "msg": "enter a valid email address", "param": "email", "location": "body" }
]
}
एंडपॉइंट टेबल कैसे पढ़ें
प्रत्येक मॉड्यूल पृष्ठ एंडपॉइंट को कंट्रोलर के अनुसार व्यवस्थित करता है। टेबल में ये कॉलम उपयोग होते हैं:
| कॉलम | विवरण |
|---|---|
| Method | HTTP विधि (GET, POST, DELETE) |
| Path | कंट्रोलर के बेस पथ के सापेक्ष रूट पथ |
| Auth | JWT = Bearer टोकन आवश्यक है, Public = किसी प्रमाणीकरण की आवश्यकता नहीं |
| Permission | आवश्यक अनुमति (जैसे People.Edit)। — का अर्थ है कोई भी प्रमाणित उपयोगकर्ता |
| Description | एंडपॉइंट क्या करता है |
जो कंट्रोलर मानक CRUD बेस क्लास का विस्तार करते हैं, वे स्वचालित रूप से चार एंडपॉइंट प्रदान करते हैं: GET / (सभी की सूची), GET /:id (ID से प्राप्त करें), POST / (बनाएँ/अपडेट करें), और DELETE /:id (हटाएँ)।
रिपोर्टिंग मॉड्यूल
रिपोर्टिंग मॉड्यूल अन्य मॉड्यूल से अलग तरीके से काम करता है। डेटाबेस-आधारित CRUD के बजाय, यह डिस्क पर मौजूद JSON फ़ाइलों से रिपोर्ट परिभाषाएँ लोड करता है और पैरामीटराइज़्ड SQL क्वेरी चलाता है।
| Method | Path | Auth | Description |
|---|---|---|---|
| GET | /reporting/reports/:keyName | JWT | की-नेम द्वारा रिपोर्ट परिभाषा लोड करें |
| GET | /reporting/reports/:keyName/run | JWT | रिपोर्ट चलाएँ और परिणाम लौटाएँ |
रिपोर्ट पैरामीटर क्वेरी स्ट्रिंग मानों के रूप में पास किए जाते हैं (जैसे ?startDate=2024-01-01&endDate=2024-12-31)। churchId पैरामीटर JWT टोकन से स्वचालित रूप से जोड़ा जाता है। प्रत्येक रिपोर्ट परिभाषा अपनी अनुमति आवश्यकताएँ निर्दिष्ट कर सकती है।
मॉड्यूल सूची
| मॉड्यूल | बेस पथ | विवरण |
|---|---|---|
| Authentication | /membership/users, /membership/oauth | लॉगिन, पंजीकरण, JWT टोकन, OAuth, अनुमतियाँ |
| Membership | /membership/* | लोग, चर्च, समूह, परिवार, भूमिकाएँ, फ़ॉर्म, सेटिंग्स |
| Attendance | /attendance/* | कैंपस, सेवाएँ, सत्र, विज़िट, चेक-इन रिकॉर्ड |
| Content | /content/* | पृष्ठ, प्रवचन, इवेंट, फ़ाइलें, गैलरी, बाइबल, स्ट्रीमिंग |
| Giving | /giving/* | दान, फ़ंड, भुगतान गेटवे, सदस्यताएँ |
| Messaging | /messaging/* | वार्तालाप, सूचनाएँ, डिवाइस, SMS |
| Doing | /doing/* | योजनाएँ, कार्य, असाइनमेंट, ऑटोमेशन, शेड्यूलिंग |