BiteSpeed Identity Reconciliation API

The BiteSpeed Contact Reconciliation API is a Node.js-based service for managing and identifying contacts using email and/or phone numbers. It links primary and secondary contacts efficiently, storing the data in a MySQL database.

---

🚀 Features

1. Contact Identification (POST /identify)

• Accepts email and/or phone number in the request body.
• Performs the following:
  • Identifies existing contacts based on the input.
  • Links secondary contacts to the primary contact.
  • Creates a new primary contact if no match is found.
• Returns a structured response:

  {
    "contact": {
      "primaryContactId": 1,
      "emails": ["test@example.com"],
      "phoneNumbers": ["1234567890"],
      "secondaryContactIds": [2, 3]
    }
  }
  

2. Retrieve All Contacts (GET /identify)

   • Fetches all stored contacts for debugging or testing.

🛠️ Tech Stack

•	Backend: Node.js, Express.js
•	Database: MySQL
•	ORM/Driver: mysql2/promise
•	Environment Variables: dotenv

📦 Setup and Installation

Follow these steps to set up the project locally:

1. Clone the Repository

git clone https://github.com/Aryan2vb/biteSpeed.git
cd biteSpeed

2. Install Dependencies

npm install

3. Configure Environment Variables

Create a .env file in the root directory with the following variables:

DB_HOST=<your_db_host>
DB_USER=<your_db_user>
DB_PASSWORD=<your_db_password>
DB_NAME=<your_db_name>
DB_PORT=<your_db_port>

4. Set Up the Database

Create a MySQL database and table named Contact using the schema below:

CREATE TABLE Contact ( id INT AUTO_INCREMENT PRIMARY KEY, email VARCHAR(255), phoneNumber VARCHAR(20), linkedId INT, linkPrecedence ENUM('primary', 'secondary'), createdAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP, updatedAt TIMESTAMP DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, deletedAt TIMESTAMP NULL );

5. Start the Server

npm start

The server will run at http://localhost:3000.

📋 API Endpoints

1. POST /identify

Identifies or creates a contact based on provided email and/or phone number.

Request Body

{
  "email": "test@example.com",
  "phoneNumber": "1234567890"
}

Response Body

{
  "contact": {
    "primaryContactId": 1,
    "emails": ["test@example.com"],
    "phoneNumbers": ["1234567890"],
    "secondaryContactIds": [2, 3]
  }
}

2. GET /identify

Fetches all stored contacts.

Response Body

[
  {
    "id": 1,
    "email": "test@example.com",
    "phoneNumber": "1234567890",
    "linkedId": null,
    "linkPrecedence": "primary",
    "createdAt": "2024-11-27T12:00:00Z",
    "updatedAt": "2024-11-27T12:00:00Z",
    "deletedAt": null
  }
]

🛡️ Error Handling

•	400 Bad Request: Missing required fields (email or phoneNumber).
•	500 Internal Server Error: Database or server issues.