Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/divspark/cij-business-profile

This is business profile backend of Connect India Japan
https://github.com/divspark/cij-business-profile

Last synced: about 6 hours ago
JSON representation

This is business profile backend of Connect India Japan

Host: GitHub
URL: https://github.com/divspark/cij-business-profile
Owner: divspark
Created: 2024-11-09T14:26:10.000Z (10 days ago)
Default Branch: main
Last Pushed: 2024-11-09T15:03:25.000Z (10 days ago)
Last Synced: 2024-11-09T15:30:44.280Z (10 days ago)
Language: JavaScript
Homepage: https://cij-business-profile-delta.vercel.app
Size: 33.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: Readme.md

Awesome Lists containing this project

README

# Connect India Japan API Documentation

## Overview
This document provides an overview of the API endpoints for managing Customers, Companies, and Products, along with instructions on how to set up and start the project.

## Project Structure
```
/Business_Profile_Backend_New
│
├── /config # Configuration files
│ └── db.js # Database connection setup
│
├── /controller # Controllers for handling requests
│ ├── CustomerController.js
│ ├── CompanyController.js
│ └── ProductController.js
│
├── /middleware # Middleware functions
│ └── auth.js # Authentication middleware
│
├── /model # Mongoose models
│ ├── CustomerSchema.js
│ ├── CompanySchema.js
│ └── ProductSchema.js
│
├── /routes # API route definitions
│ ├── customerRoutes.js
│ ├── companyRoutes.js
│ └── productRoutes.js
│
├── /utils # Utility functions
│ └── sendEmail.js # Email sending functionality
│
├── .env # Environment variables
├── server.js # Main server file
└── package.json # Project dependencies and scripts
```

## How to Start the Project
1. **Clone the repository:**
```bash
git clone
cd Business_Profile_Backend_New
```

2. **Install dependencies:**
```bash
npm install
```

3. **Create a `.env` file in the root directory and add your environment variables (see below).**

4. **Start the server:**
```bash
npm start
```

## Environment Variables
Ensure you set the following environment variables in your `.env` file:
```plaintext
MONGO_URI=
JWT_SECRET=
EMAIL_USER=
EMAIL_PASS=
```

## API Endpoints

## Customer APIs

### 1. Create Customer
- **Endpoint:** `POST /customer/create`
- **Request Body:**
```json
{
"Name": "John Doe",
"MobileNumber": "1234567890",
"Email": "[email protected]",
"Pincode": "123456",
"District": "Example District",
"Country": "Country Name",
"AreaOrStreet": "Example Street",
"Landmark": "Near Park",
"password": "SecurePassword123"
}
```

---

### 2. Customer Login
- **Endpoint:** `POST /customer/login`
- **Request Body:**
```json
{
"Email": "[email protected]",
"password": "SecurePassword123"
}
```

- **Response:**
- On success:
```json
{
"success": true,
"message": "Login successful.",
"token": "your_jwt_token"
}
```
- On failure:
```json
{
"success": false,
"message": "Invalid email or password."
}
```

---

### 3. Get Customer Profile
- **Endpoint:** `GET /customer/profile`
- **Headers:**
```plaintext
Authorization: Bearer your_jwt_token
```

- **Response:**
```json
{
"success": true,
"customer": {
"Name": "John Doe",
"MobileNumber": "1234567890",
"Email": "[email protected]",
"Pincode": "123456",
"District": "Example District",
"Country": "Country Name",
"AreaOrStreet": "Example Street",
"Landmark": "Near Park"
}
}
```

---

### 4. Update Customer Profile
- **Endpoint:** `PUT /customer/update`
- **Headers:**
```plaintext
Authorization: Bearer your_jwt_token
```

- **Request Body:**
```json
{
"MobileNumber": "0987654321",
"AreaOrStreet": "New Street",
"Landmark": "Near Mall"
}
```

- **Response:**
```json
{
"success": true,
"message": "Customer profile updated successfully."
}
```

---

## Company APIs

### 1. Create Company
- **Endpoint:** `POST /company/create`
- **Request Body:**
```json
{
"CompanyName": "Example Corp",
"ContactPersonName": "John Doe",
"PrimaryMobileNumber": "1234567890",
"PrimaryEmail": "[email protected]",
"Pincode": "123456",
"District": "Example District",
"Country": "Country Name",
"City": "Example City",
"State": "Example State",
"BuildingNumberOrFloor": "1st Floor",
"GSTIN": "GST123456789",
"PrimaryBusinessType": "Service",
"CEOName": "Jane Doe",
"GSTRegistrationDate": "2022-01-01",
"OwnershipType": "Private Limited",
"password": "Ravi@123456"
}
```

---

### 2. Company Login
- **Endpoint:** `POST /company/login`
- **Request Body:**
```json
{
"PrimaryEmail": "[email protected]",
"password": "Ravi@123456"
}
```

---

### 3. Get Company Profile
- **Endpoint:** `GET /company/profile`
- **Headers:**
```plaintext
Authorization: Bearer your_jwt_token
```

- **Response:**
```json
{
"success": true,
"company": {
"CompanyName": "Example Corp",
"ContactPersonName": "John Doe",
"PrimaryMobileNumber": "1234567890",
"PrimaryEmail": "[email protected]",
"Pincode": "123456",
"District": "Example District",
"Country": "Country Name",
"City": "Example City",
"State": "Example State",
"BuildingNumberOrFloor": "1st Floor",
"GSTIN": "GST123456789",
"PrimaryBusinessType": "Service",
"CEOName": "Jane Doe",
"GSTRegistrationDate": "2022-01-01",
"OwnershipType": "Private Limited"
}
}
```

---

### 4. Update Company Profile
- **Endpoint:** `PUT /company/update`
- **Headers:**
```plaintext
Authorization: Bearer your_jwt_token
```

- **Request Body:**
```json
{
"ContactPersonName": "Jane Smith",
"PrimaryMobileNumber": "0987654321"
}
```

- **Response:**
```json
{
"success": true,
"message": "Company profile updated successfully."
}
```

---

## Product APIs

### 1. Create Product
- **Endpoint:** `POST /product/create`
- **Request Body:**
```json
{
"ProductName": "Sample Product",
"CompanyId": "company_id_here",
"Description": "This is a sample product description.",
"Price": 100.00,
"Quantity": 50,
"Category": "Electronics"
}
```

- **Response:**
```json
{
"success": true,
"message": "Product created successfully."
}
```

---

### 2. Get Product Details by Product Name
- **Endpoint:** `GET /product/details`
- **Query Parameters:**
- `ProductName`: The name of the product.

- **Response:**
```json
{
"success": true,
"product": {
"ProductName": "Sample Product",
"Description": "This is a sample product description.",
"Price": 100.00,
"Quantity": 50,
"Category": "Electronics"
}
}
```

---

### 3. Get All Products of a Company
- **Endpoint:** `GET /product/company`
- **Query Parameters:**
- `CompanyId`: The ID of the company.

- **Response:**
```json
{
"success": true,
"products": [
{
"ProductName": "Sample Product 1",
"Description": "Description of Sample Product 1",
"Price": 100.00,
"Quantity": 50,
"Category": "Electronics"
},
{
"ProductName": "Sample Product 2",
"Description": "Description of Sample Product 2",
"Price": 200.00,
"Quantity": 30,
"Category": "Home Appliances"

}
]
}
```