{ "openapi": "3.0.0", "info": { "title": "BFOMI API's", "version": "1.0" }, "servers": [ { "url": "/api" }, { "url": "/bfomi/public/api" } ], "paths": { "/book": { "get": { "tags": [ "Book" ], "operationId": "44d783c68edc066fecefd007420900f3", "responses": { "200": { "description": "Book list", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/book/detail/{book}": { "get": { "tags": [ "Book" ], "operationId": "713906d094c2ede5578005ac41624100", "parameters": [ { "name": "book", "in": "path", "description": "Book ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Book list", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/chat/open": { "get": { "tags": [ "Chat" ], "summary": "To fetch and create room with admin", "operationId": "3d5c5a9d739d1a9c3dd00494a26eb6b4", "responses": { "200": { "description": "Chat Fetched Successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/chat/message/{chat}": { "post": { "tags": [ "Chat" ], "summary": "Send Message To Admin", "operationId": "37834fedad8653783ea72f44438174e5", "parameters": [ { "name": "chat", "in": "path", "description": "Chat Room Id To Fetch Chat Room", "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "content" ], "properties": { "content": { "description": "Text Message", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Message Send Successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/church": { "get": { "tags": [ "Church" ], "operationId": "a5366eac0709e21da2b37b2bf94441ec", "responses": { "200": { "description": "My Church", "content": { "application/json": { "schema": {} } } } } } }, "/cms": { "get": { "tags": [ "CMS Pages" ], "operationId": "29603f0d985483702fe9657db8d4dd7d", "responses": { "200": { "description": "CMS Pages", "content": { "application/json": { "schema": {} } } } } } }, "/cms/{id}": { "get": { "tags": [ "CMS Pages" ], "operationId": "b12ed2db3caa74538f94665ef332aaba", "parameters": [ { "name": "id", "in": "path", "description": "CMS Page ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "CMS Pages", "content": { "application/json": { "schema": {} } } } } } }, "/event": { "get": { "tags": [ "Event" ], "operationId": "1db7372f262e469a249302ecb84569ac", "parameters": [ { "name": "search", "in": "query", "description": "Search event by title", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Filter events by specific date (Y-m-d)", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Event list", "content": { "application/json": { "schema": {} } } } } } }, "/event/detail/{event}": { "get": { "tags": [ "Event" ], "operationId": "5891db5d579b51744e01c1195fdd7919", "parameters": [ { "name": "event", "in": "path", "description": "Event ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Event list", "content": { "application/json": { "schema": {} } } } } } }, "/event/bookmark": { "get": { "tags": [ "Event" ], "operationId": "3afd0e5bef2ab15a00ad6f822707c21d", "responses": { "200": { "description": "Event list", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Event" ], "summary": "Toggle bookmark for an event", "operationId": "3d018a1c7ea485e9f69d0e58e2759d1f", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "event_id": { "description": "ID of the event to bookmark", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Bookmark toggled successfully", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string" }, "bookmarked": { "type": "boolean" } }, "type": "object" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/event/categories": { "get": { "tags": [ "Event" ], "operationId": "2831744e095934b85f72f756d47a8326", "responses": { "200": { "description": "Event categories list", "content": { "application/json": { "schema": {} } } } } } }, "/event/purchase/{event}": { "post": { "tags": [ "Event" ], "summary": "Purchase Event", "operationId": "6fd7a6658a108f6c7b4ebebed4a90f07", "parameters": [ { "name": "event", "in": "path", "description": "Event ID to purchase", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "amount", "stripe_token" ], "properties": { "stripe_token": { "description": "Stripe Payment Intent Token", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Event ticket purchased", "content": { "application/json": { "schema": { "properties": { "message": { "type": "string", "example": "Event ticket purchased successfully" } }, "type": "object" } } } } }, "security": [ { "BearerAuth": [] } ] } }, "/what-we-believe-faq": { "get": { "tags": [ "What We Believe Faq" ], "operationId": "c5dd3d39bf1590666c68db94f375abf1", "responses": { "200": { "description": "What We Believe Faq list", "content": { "application/json": { "schema": {} } } } } } }, "/formSubmition": { "post": { "tags": [ "Form Submition" ], "operationId": "f68f7581fc052a43d6d20513c8c51a7c", "requestBody": { "description": "Form Submition", "required": true, "content": { "application/json": { "schema": { "required": [ "first_name", "last_name", "email", "message" ], "properties": { "email": { "description": "Email", "type": "string" }, "first_name": { "description": "First Name", "type": "string" }, "last_name": { "description": "Last Name", "type": "string" }, "message": { "description": "Message", "type": "string" }, "address": { "description": "Address", "type": "string" }, "phone_no": { "description": "Phone Number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Form Submition", "content": { "application/json": { "schema": {} } } } } } }, "/payment/intent": { "post": { "tags": [ "Payment" ], "operationId": "b2a594c85826cc36bdd25b5e4df59315", "requestBody": { "description": "Generate Payment Intent", "required": true, "content": { "application/json": { "schema": { "required": [ "amount" ], "properties": { "amount": { "description": "Amount for generating payment", "type": "integer" } }, "type": "object", "example": { "amount": 99 } } } } }, "responses": { "200": { "description": "Generate Payment Intent", "content": { "application/json": { "schema": {} } } } } } }, "/polling": { "get": { "tags": [ "Polling" ], "operationId": "18149e35591f11882fea55b3bdab0ad2", "responses": { "200": { "description": "Polling list", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/polling/vote/{poll_option}": { "post": { "tags": [ "Polling" ], "summary": "Vote Polling", "operationId": "ec88b6ca8134eea11539f3500a07890b", "parameters": [ { "name": "poll_option", "in": "path", "description": "Option ID For Vote", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Voted successfully" } }, "security": [ { "BearerAuth": [] } ] } }, "/prayerRequest": { "get": { "tags": [ "Prayer Request" ], "operationId": "2331e0627dd8afd04a924d9a05d6a95d", "responses": { "200": { "description": "Prayer Request list", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Prayer Request" ], "operationId": "e8732d9bcee8730eb485e1d729619f63", "requestBody": { "description": "Prayer Request", "required": true, "content": { "application/json": { "schema": { "required": [ "phone_no", "message" ], "properties": { "phone_no": { "description": "Phone Number", "type": "string" }, "message": { "description": "Message", "type": "string" }, "name": { "description": "Name", "type": "string" }, "email": { "description": "Email", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Prayer Request", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/user": { "get": { "tags": [ "Profile" ], "operationId": "6570178f86b0b35fad12ad0af4b00449", "responses": { "200": { "description": "User", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] }, "post": { "tags": [ "Profile" ], "operationId": "77dfb34fb8a3ecbe7a26f718c3a01dcc", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "_method", "name", "email" ], "properties": { "_method": { "type": "string", "example": "put" }, "name": { "description": "User name", "type": "string" }, "email": { "description": "User email", "type": "string", "format": "email" }, "phone": { "description": "User phone number", "type": "string", "format": "02190832532" }, "dob": { "description": "User Date Of Birth", "type": "string", "format": "2027-10-21" }, "gender": { "description": "User Gender", "type": "string", "format": "Male" }, "about_me": { "description": "User About Me", "type": "string", "format": "This is my about" }, "image": { "description": "Profile image file", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "200": { "description": "Profile updated successfully", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/user/update-password": { "post": { "tags": [ "Profile" ], "operationId": "5ab4a565149a62cf26802f4d3cfbd435", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "_method", "current_password", "password", "password_confirmation" ], "properties": { "_method": { "type": "string", "example": "put" }, "current_password": { "description": "Current Password of the user", "type": "string", "example": "" }, "password": { "description": "New Password of the user", "type": "string", "example": "" }, "password_confirmation": { "description": "Confirmation Password", "type": "string", "example": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Password updated successfully", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/sermon": { "get": { "tags": [ "Sermon" ], "operationId": "449c83b9e659ffaf1cd1559175fb571f", "parameters": [ { "name": "search", "in": "query", "description": "Search sermon by title", "required": false, "schema": { "type": "string" } }, { "name": "media_type", "in": "query", "description": "Filter sermon by Media Type video | audio", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Sermon list", "content": { "application/json": { "schema": {} } } } } } }, "/auth/register": { "post": { "tags": [ "Authentication" ], "operationId": "a5e99257a0d904a2e1aedcc3e0621065", "requestBody": { "description": "User registration", "required": true, "content": { "application/json": { "schema": { "required": [ "name", "email", "password", "password_confirmation", "phone", "city", "country", "state" ], "properties": { "name": { "description": "Name of the user", "type": "string" }, "email": { "description": "Email of the user", "type": "string" }, "password": { "description": "Password of the user", "type": "string" }, "password_confirmation": { "description": "Confirmation Password", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "User Registration", "content": { "application/json": { "schema": {} } } } } } }, "/auth/login": { "post": { "tags": [ "Authentication" ], "operationId": "cd16214b6282a5fcaf30cc623048e161", "requestBody": { "description": "User login", "required": true, "content": { "application/json": { "schema": { "required": [ "email", "password" ], "properties": { "email": { "description": "Email of the user", "type": "string" }, "password": { "description": "Password of the user", "type": "string" } }, "type": "object", "example": { "email": "johndoe@mailinator.com", "password": "testing.." } } } } }, "responses": { "200": { "description": "User Login", "content": { "application/json": { "schema": {} } } } } } }, "/user/logout": { "post": { "tags": [ "Profile" ], "operationId": "808dff22421b866c8f0d6cd826e77b3b", "responses": { "200": { "description": "User Logout", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/auth/forget/password": { "post": { "tags": [ "Authentication" ], "operationId": "2cb31f1a9f3cabbd474b1b6680ec6dab", "requestBody": { "description": "User login", "required": true, "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "description": "Email of the user", "type": "string" } }, "type": "object", "example": { "email": "johndoe@mailinator.com" } } } } }, "responses": { "200": { "description": "User Forgot Password", "content": { "application/json": { "schema": {} } } } } } }, "/auth/update/password": { "post": { "tags": [ "Authentication" ], "operationId": "38e354e42cfaa6d708a7876341c71475", "requestBody": { "description": "User update password request", "required": true, "content": { "application/json": { "schema": { "required": [ "email", "code", "password" ], "properties": { "email": { "description": "Email of the user", "type": "string", "example": "johndoe@mailinator.com" }, "code": { "description": "Code for password reset", "type": "string", "example": "abc123" }, "password": { "description": "New password", "type": "string", "example": "newpassword" }, "password_confirmation": { "description": "Password confirmation", "type": "string", "example": "newpassword" } }, "type": "object" } } } }, "responses": { "200": { "description": "User Update Password", "content": { "application/json": { "schema": {} } } } } } }, "/contact": { "post": { "tags": [ "Contact" ], "operationId": "be2e07a306c3fc6abb8257fabdd15de2", "requestBody": { "description": "Contact Email", "required": true, "content": { "application/json": { "schema": { "required": [ "first_name", "last_name", "email", "message" ], "properties": { "email": { "description": "Email", "type": "string" }, "first_name": { "description": "First Name", "type": "string" }, "last_name": { "description": "Last Name", "type": "string" }, "message": { "description": "Message", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Contact Email", "content": { "application/json": { "schema": {} } } } } } }, "/get-states": { "get": { "tags": [ "States" ], "operationId": "19de16fc46ef7fb0c954b67a8455c77a", "responses": { "200": { "description": "States list", "content": { "application/json": { "schema": {} } } } } } }, "/user/delete-profile": { "get": { "tags": [ "Profile" ], "operationId": "0bc73e3c671a904f54cbbca9ad0c03dd", "responses": { "200": { "description": "User", "content": { "application/json": { "schema": {} } } } }, "security": [ { "BearerAuth": [] } ] } }, "/settings": { "get": { "tags": [ "Website Settings" ], "summary": "Get all website settings", "description": "Retrieve all saved website settings (Stripe keys, mode, etc.)", "operationId": "e2b130967685f45cbd886b62a82f4c9a", "responses": { "200": { "description": "Settings retrieved successfully", "content": { "application/json": { "schema": {}, "example": { "success": true, "message": "Settings fetched successfully", "data": { "stripe_test_key": "pk_test_abc", "stripe_test_secret": "sk_test_abc", "stripe_live_key": "pk_live_abc", "stripe_live_secret": "sk_live_abc", "sandbox_mode": true } } } } } } } }, "/settings/update": { "post": { "tags": [ "Website Settings" ], "summary": "Update website settings", "description": "Save or update Stripe keys and sandbox/live mode.", "operationId": "001160875fcdc996b99a0e4ba4486e98", "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "required": [ "stripe_test_key", "stripe_test_secret", "stripe_live_key", "stripe_live_secret", "sandbox_mode" ], "properties": { "stripe_test_key": { "description": "Stripe Test Publishable Key (used in sandbox mode)", "type": "string", "example": "pk_test_51NBxxxxxx" }, "stripe_test_secret": { "description": "Stripe Test Secret Key (used in sandbox mode)", "type": "string", "example": "sk_test_51NBxxxxxx" }, "stripe_live_key": { "description": "Stripe Live Publishable Key (used in live mode)", "type": "string", "example": "pk_live_51NBxxxxxx" }, "stripe_live_secret": { "description": "Stripe Live Secret Key (used in live mode)", "type": "string", "example": "sk_live_51NBxxxxxx" }, "sandbox_mode": { "description": "Enable test mode (true = sandbox/test, false = live)", "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Settings updated successfully", "content": { "application/json": { "schema": {}, "example": { "success": true, "message": "Settings updated successfully" } } } } } } }, "/settings/check-stripe": { "get": { "tags": [ "Website Settings" ], "summary": "Check Stripe connection (auto-switch test/live)", "description": "Automatically tests connection to Stripe API using the currently active mode (sandbox or live).", "operationId": "e9c1f0910de55ec0b5e78e6fafe80e64", "responses": { "200": { "description": "Stripe connection status", "content": { "application/json": { "schema": {}, "example": { "success": true, "message": "Stripe connection successful", "data": { "balance": { "available": [ { "amount": 10000, "currency": "usd" } ] } } } } } } } } }, "/faq": { "get": { "tags": [ "Faq" ], "operationId": "50f43dd7a90463c6131407aebf55b58a", "responses": { "200": { "description": "Faq list", "content": { "application/json": { "schema": {} } } } } } } }, "components": { "securitySchemes": { "BearerAuth": { "type": "http", "description": "Enter JWT Bearer token **_only_**", "name": "Authorization", "in": "header", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "Authentication" }, { "name": "Book", "description": "Book" }, { "name": "Chat", "description": "Chat" }, { "name": "Church", "description": "Church" }, { "name": "CMS Pages", "description": "CMS Pages" }, { "name": "Event", "description": "Event" }, { "name": "What We Believe Faq", "description": "What We Believe Faq" }, { "name": "Form Submition", "description": "Form Submition" }, { "name": "Payment", "description": "Payment" }, { "name": "Polling", "description": "Polling" }, { "name": "Prayer Request", "description": "Prayer Request" }, { "name": "Profile", "description": "Profile" }, { "name": "Sermon", "description": "Sermon" }, { "name": "Contact", "description": "Contact" }, { "name": "States", "description": "States" }, { "name": "Website Settings", "description": "Website Settings" }, { "name": "Faq", "description": "Faq" } ] }