Consumable Replacement Notification API Developer Guide

Service Overview

The Replacement Notification service is a telematics service that monitors vehicle consumables and provides replacement notifications and maintenance recommendations through mobile apps or web platforms.

Service Features

Consumable lifecycle monitoring
Replacement due notifications
Maintenance scheduling assistance
Cost estimation for replacements
Service center recommendations

Legal Requirements

Compliance with Personal Information Protection Act
Explicit consent required for vehicle data collection
Compliance with data retention policies
Maintenance record protection

Key Scenarios

Scenario 1: Consumable Status Update Request and Processing

API Flow by Entity:

📱 App (User):

Status Query: Query current consumable status
Status Check: Check status update progress (in progress/completed)
Notification Reception: Receive replacement due notifications

🚗 Vehicle (TCU):

Sensor Data Collection: Collect consumable status data from all sensors
Data Transmission: Transmit consumable status data to server
Replacement Detection: Detect items requiring replacement

🏢 Call Center:

Duplicate Request Prevention: Apply duplicate request prevention logic
Command Transmission: Send consumable status update command to vehicle
Data Processing: Process and validate received consumable data
Replacement Analysis: Analyze replacement requirements
Notification Generation: Generate replacement notifications
Storage: Store consumable data with timestamp

Scenario 2: Real-time Consumable Status Query

API Flow by Entity:

📱 App (User):

Status Query: Query current consumable status
Status Display: Display status of all consumables
Replacement Indication: Display replacement due indicators

🏢 Call Center:

Status Provision: Provide latest consumable status
Status Management: Automatic management of consumable status
Data Caching: Efficient caching of consumable data
Status Analysis: Analyze consumable usage patterns

Scenario 3: Consumable History Query

API Flow by Entity:

📱 App (User):

Lifecycle Query: Query consumable lifecycle status
History Display: Display replacement history timeline
Pattern Analysis: Display consumable usage pattern analysis

🏢 Call Center:

History Management: Automatic management of consumable replacement history
Pattern Analysis: Analyze consumable usage patterns
Statistics Generation: Generate replacement statistics

Scenario 4: Replacement Notifications and Alerts

API Flow by Entity:

📱 App (User):

Alert Setup: Configure replacement alerts
Alert Reception: Receive replacement due notifications
Alert Management: Manage alert preferences

🏢 Call Center:

Alert Monitoring: Monitor consumables for replacement requirements
Alert Generation: Generate replacement notifications
Push Notifications: Send push notifications to user app
Escalation: Escalate critical replacement needs

Scenario 5: Maintenance Scheduling

API Flow by Entity:

📱 App (User):

Scheduling Request: Request maintenance scheduling
Service Center Selection: Select preferred service center
Appointment Booking: Book maintenance appointment

🏢 Call Center:

Scheduling Processing: Process maintenance scheduling requests
Service Center Coordination: Coordinate with service centers
Appointment Confirmation: Confirm appointment details
Reminder Management: Manage appointment reminders

Scenario 6: Cost Estimation and Quotes

API Flow by Entity:

📱 App (User):

Cost Query: Query replacement cost estimation
Quote Request: Request detailed quotes
Comparison: Compare service center prices

🏢 Call Center:

Cost Analysis: Analyze replacement costs
Quote Generation: Generate detailed quotes
Price Comparison: Provide price comparisons
Discount Information: Provide discount information

Scenario 7: Real-time Replace Events

API Flow by Entity:

📱 App (User):

SSE Connection: Connect to real-time replace event stream
Real-time Reception: Receive consumable status changes in real-time

🏢 Call Center:

Event Stream Provision: Provide real-time replace event stream
Event Transmission: Transmit replace status change events in real-time

Scenario 8: Service Center Recommendations

API Flow by Entity:

📱 App (User):

Recommendation Query: Query service center recommendations
Center Selection: Select preferred service center
Review Display: Display service center reviews

🏢 Call Center:

Recommendation Generation: Generate service center recommendations
Quality Analysis: Analyze service center quality
Availability Check: Check service center availability
Review Management: Manage service center reviews

Key Features

📱 Features to Implement in App

1. Consumable Status Monitoring

Status Query: Query current consumable status
Status Display: Display status of all consumables
Replacement Indicators: Display replacement due indicators
Real-time Updates: Real-time consumable status updates
Progress Display: Display consumable lifecycle progress

2. Replacement History

Lifecycle Query: Query consumable lifecycle
Timeline Display: Display replacement history timeline
Pattern Analysis: Display consumable usage pattern analysis
Statistics: Display replacement statistics

3. Alerts and Notifications

Alert Setup: Configure replacement alerts
Alert Reception: Receive replacement due notifications
Alert Management: Manage alert preferences
Alert History: Display alert history

4. Maintenance Scheduling

Scheduling Request: Request maintenance scheduling
Service Center Selection: Select preferred service center
Appointment Booking: Book maintenance appointments
Calendar Integration: Integrate with user calendar

5. Cost Estimation

Cost Query: Query replacement cost estimation
Quote Display: Display detailed quotes
Price Comparison: Compare service center prices
Budget Planning: Plan replacement budget

6. Service Center Recommendations

Recommendation Query: Query service center recommendations
Center Display: Display recommended service centers
Review Display: Display service center reviews
Location Display: Display service center locations

7. Real-time Event Reception

SSE Connection: Connect to real-time replace event stream
Real-time Reception: Receive consumable status changes in real-time
Event Processing: Process and display received events

🏢 Features to Implement in Call Center

1. Consumable Data Collection System

Data Reception: Receive consumable status data in real-time
Data Storage: Secure storage of consumable data
Status Management: Automatic management of latest consumable status
Quality Management: Manage consumable data quality and accuracy
Data Validation: Validate consumable data validity

2. Replacement History Management System

History Collection: Automatic collection of replacement history
Lifecycle Management: Automatic management of replacement history
Pattern Analysis: Automatic analysis of consumable usage patterns
Statistics Generation: Automatic generation of replacement statistics

3. Alert and Notification System

Alert Monitoring: Monitor consumables for replacement requirements
Alert Generation: Automatic generation of replacement notifications
Push Notifications: Automatic sending of push notifications to user app
Alert Escalation: Escalate critical replacement needs
Alert Configuration: Management of alert configurations

4. Maintenance Scheduling System

Scheduling Processing: Process maintenance scheduling requests
Service Center Coordination: Coordinate with service centers
Appointment Management: Manage appointment bookings
Reminder Management: Manage appointment reminders
Calendar Integration: Integrate with calendar systems

5. Cost Estimation System

Cost Analysis: Automatic analysis of replacement costs
Quote Generation: Generate detailed quotes
Price Comparison: Provide price comparisons
Discount Management: Manage discount information
Budget Planning: Provide budget planning tools

6. Service Center Recommendation System

Recommendation Generation: Generate service center recommendations
Quality Analysis: Analyze service center quality
Availability Management: Manage service center availability
Review Management: Manage service center reviews
Location Services: Provide service center location services

7. API Service Management

API Response Processing: Process replace notification related API requests
Request Validation: Validate API requests
Performance Monitoring: Monitor API response time and availability
Error Handling: Handle API errors and exceptions
Version Management: Manage API versions and compatibility

8. Security and Privacy

Consumable Data Consent: Manage consent for consumable data collection
Privacy Protection: Protect user consumable data privacy
Data Security: Secure processing of consumable data
Audit Logging: Maintain audit logs for consumable data access
Access Control: Manage user-specific replace notification access permissions

9. System Operations and Monitoring

System Status Monitoring: 24/7 monitoring of replace notification system
Data Quality Management: Manage consumable data quality and accuracy
Sensor Status Monitoring: Monitor consumable sensor communication status
Exception Handling: Handle network, sensor, data processing exceptions
System Optimization: Optimize consumable data processing logic

10. Data Analysis and Statistics

Pattern Analysis: Automatic analysis of consumable usage patterns
Usage Statistics: Automatic generation of replace notification usage statistics
Service Quality Analysis: Automatic analysis of replace notification service quality
Improvement Recommendations: Automatic generation of service improvement recommendations

Sequence Diagram

Replace Notification System Flow

Replace Notification

API Endpoints

Refer to the Common API Specifications for headers, response codes, and error formats.

Current Consumable Status Query

bash

curl -X GET "https://api.ecarus.run/api/v1/information/vehicles/KMHSH81C7LU123456/consumables/status" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Consumable Lifecycle Query

bash

curl -X GET "https://api.ecarus.run/api/v1/information/vehicles/KMHSH81C7LU123456/consumables/lifecycle" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Consumable Replacement Reset

bash

curl -X POST "https://api.ecarus.run/api/v1/information/vehicles/KMHSH81C7LU123456/consumables/reset" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d" \
     -H "Content-Type: application/json" \
     -d '{"consumableType": "engineOil", "resetMileage": 45000}'

Consumable Recommendations Query

bash

curl -X GET "https://api.ecarus.run/api/v1/information/vehicles/KMHSH81C7LU123456/consumables/recommendations" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d"

Replacement Alert Configuration

bash

curl -X PUT "https://api.ecarus.run/api/v1/information/vehicles/KMHSH81C7LU123456/consumables/alerts" \
     -H "Authorization: Bearer sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d" \
     -H "Content-Type: application/json" \
     -d '{"advanceWarningDays": 30, "criticalWarningDays": 7, "notificationTypes": ["PUSH", "EMAIL"]}'

Data Models

Consumable Status Information Response

json

{
  "vin": "KMHSH81C7LU123456",
  "userId": "user123",
  "timestamp": "2026-01-13T14:30:00Z",
  "consumables": {
    "engineOil": {
      "status": "DUE_SOON",
      "currentLevel": 75,
      "replacementInterval": 10000,
      "lastReplacement": {
        "date": "2025-06-15T00:00:00Z",
        "mileage": 38200
      },
      "nextReplacement": {
        "estimatedDate": "2026-02-10T00:00:00Z",
        "estimatedMileage": 50000,
        "remainingMileage": 1800,
        "remainingDays": 28
      },
      "recommendedProduct": "5W-30 Synthetic Oil",
      "estimatedCost": 85000
    },
    "oilFilter": {
      "status": "GOOD",
      "replacementInterval": 10000,
      "lastReplacement": {
        "date": "2025-06-15T00:00:00Z",
        "mileage": 38200
      },
      "nextReplacement": {
        "estimatedDate": "2026-02-10T00:00:00Z",
        "estimatedMileage": 50000,
        "remainingMileage": 1800,
        "remainingDays": 28
      },
      "recommendedProduct": "OEM Oil Filter",
      "estimatedCost": 15000
    },
    "airFilter": {
      "status": "GOOD",
      "replacementInterval": 20000,
      "lastReplacement": {
        "date": "2025-01-10T00:00:00Z",
        "mileage": 30000
      },
      "nextReplacement": {
        "estimatedDate": "2026-07-15T00:00:00Z",
        "estimatedMileage": 60000,
        "remainingMileage": 11800,
        "remainingDays": 183
      },
      "recommendedProduct": "High-Flow Air Filter",
      "estimatedCost": 25000
    },
    "brakePads": {
      "status": "MONITOR",
      "currentThickness": {
        "front": 6.5,
        "rear": 7.2
      },
      "minimumThickness": 3.0,
      "lastReplacement": {
        "date": "2024-03-20T00:00:00Z",
        "mileage": 25000
      },
      "nextReplacement": {
        "estimatedDate": "2026-09-01T00:00:00Z",
        "estimatedMileage": 65000,
        "remainingMileage": 16800,
        "remainingDays": 231
      },
      "recommendedProduct": "Ceramic Brake Pads",
      "estimatedCost": 180000
    },
    "tires": {
      "status": "GOOD",
      "currentTread": {
        "frontLeft": 7.5,
        "frontRight": 7.8,
        "rearLeft": 6.9,
        "rearRight": 7.2
      },
      "minimumTread": 2.0,
      "lastReplacement": {
        "date": "2023-12-01T00:00:00Z",
        "mileage": 20000
      },
      "nextReplacement": {
        "estimatedDate": "2027-06-01T00:00:00Z",
        "estimatedMileage": 90000,
        "remainingMileage": 41800,
        "remainingDays": 500
      },
      "recommendedProduct": "All-Season Touring Tires",
      "estimatedCost": 600000
    },
    "battery": {
      "status": "GOOD",
      "health": 85,
      "voltage": 12.6,
      "replacementInterval": 36,
      "lastReplacement": {
        "date": "2023-06-15T00:00:00Z",
        "mileage": 15000
      },
      "nextReplacement": {
        "estimatedDate": "2026-12-01T00:00:00Z",
        "estimatedMileage": 75000,
        "remainingMileage": 26800,
        "remainingDays": 322
      },
      "recommendedProduct": "AGM Battery",
      "estimatedCost": 150000
    }
  },
  "summary": {
    "totalItems": 6,
    "dueSoon": 1,
    "monitor": 1,
    "good": 4,
    "totalEstimatedCost": 1055000,
    "nextDueDate": "2026-02-10T00:00:00Z",
    "nextDueItem": "engineOil"
  },
  "alerts": [
    {
      "alertId": "alert-001",
      "type": "REPLACEMENT_DUE",
      "severity": "MEDIUM",
      "consumable": "engineOil",
      "message": "Engine oil replacement due in 28 days",
      "dueDate": "2026-02-10T00:00:00Z",
      "remainingMileage": 1800,
      "estimatedCost": 85000,
      "timestamp": "2026-01-13T14:30:00Z",
      "acknowledged": false
    }
  ]
}

Replacement History Response

json

{
  "vin": "KMHSH81C7LU123456",
  "userId": "user123",
  "period": "24m",
  "limit": 10,
  "offset": 0,
  "history": [
    {
      "replacementId": "replace-001",
      "timestamp": "2025-06-15T10:00:00Z",
      "mileage": 38200,
      "consumable": "engineOil",
      "product": "5W-30 Synthetic Oil",
      "cost": 85000,
      "serviceCenter": {
        "name": "Official Service Center",
        "address": "123 Service Road, Seoul"
      },
      "warranty": {
        "duration": "6m",
        "mileage": 10000
      }
    },
    {
      "replacementId": "replace-002",
      "timestamp": "2025-01-10T14:30:00Z",
      "mileage": 30000,
      "consumable": "airFilter",
      "product": "High-Flow Air Filter",
      "cost": 25000,
      "serviceCenter": {
        "name": "Quick Service Shop",
        "address": "456 Quick Lane, Seoul"
      },
      "warranty": {
        "duration": "12m",
        "mileage": 20000
      }
    }
  ],
  "total": 15,
  "hasMore": true,
  "nextOffset": 10,
  "statistics": {
    "totalCost": 1250000,
    "averageCostPerReplacement": 83333,
    "mostFrequentReplacement": "engineOil",
    "totalReplacements": 15
  }
}

Replacement Alert Configuration Response

json

{
  "vin": "KMHSH81C7LU123456",
  "userId": "user123",
  "timestamp": "2026-01-13T14:30:00Z",
  "alerts": {
    "timing": {
      "advanceWarningDays": 30,
      "criticalWarningDays": 7,
      "immediateWarningDays": 1
    },
    "notifications": {
      "pushEnabled": true,
      "emailEnabled": true,
      "smsEnabled": false,
      "inAppEnabled": true,
      "severityFilter": ["MEDIUM", "HIGH", "CRITICAL"]
    },
    "consumables": {
      "engineOil": {"enabled": true, "advanceDays": 30},
      "oilFilter": {"enabled": true, "advanceDays": 30},
      "airFilter": {"enabled": true, "advanceDays": 60},
      "brakePads": {"enabled": true, "advanceDays": 90},
      "tires": {"enabled": true, "advanceDays": 120},
      "battery": {"enabled": true, "advanceDays": 90}
    },
    "schedule": {
      "quietHours": {
        "start": "22:00",
        "end": "07:00",
        "criticalAlertsEnabled": true
      },
      "frequency": {
        "dailySummary": false,
        "weeklySummary": true,
        "monthlySummary": true
      }
    }
  },
  "previousSettings": {
    "timing": {
      "advanceWarningDays": 21,
      "criticalWarningDays": 3
    }
  },
  "validation": {
    "isValid": true,
    "warnings": [
      "Advanced warning period may result in frequent notifications for multiple items"
    ],
    "errors": []
  }
}

Security and Privacy

Authentication and Authorization

User authentication token required (JWT/OAuth2)
Vehicle access permission verification
Replace notification query permission confirmation

Data Security

All API communications encrypted with HTTPS/TLS
Secure transmission of consumable data
Protection of sensitive maintenance information

Privacy Protection

Explicit consent for consumable data collection
Compliance with data retention policies
Right to data deletion upon user request

Access Control

VIN-based vehicle access permission verification
User-specific replace notification access permission management
Detection of abnormal access patterns

Exception Handling

Connection Failure: Offline mode support, last consumable data caching
Slow Response: Loading indicator, timeout handling
Server Down: Error message display, retry suggestion

Sensor Malfunction: Sensor malfunction notification
Sensor Data Invalid: Invalid sensor data notification
Sensor Communication Error: Sensor communication error notification

Replacement Overdue: Overdue replacement alert
Unexpected Wear: Unexpected wear pattern alert
Quality Issues: Product quality issue alert

Authentication Failure: Re-authentication requirement
Insufficient Permissions: Clear explanation of permission shortage
Replace Notification Access Permission: Replace notification access permission shortage notification

Test Setup

Base URL: https://api.ecarus.run/api/v1/information
Authentication Token: sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d
Sample VIN: KMHSH81C7LU123456

Use Swagger UI for interactive API testing.

Deployment Considerations

App Store Registration

Request consumable data collection permissions
Request push notification permissions
Clear description of replace notification functionality

Legal Regulation Compliance

Compliance with Personal Information Protection Act
Explicit consent required for consumable data collection
Compliance with data retention policies
Maintenance record protection

Vehicle Compatibility

Support for various vehicle models
Support for different consumable types
Consideration of OEM-specific consumable implementations
Consideration of sensor communication protocol differences

Consumable Replacement Notification API Developer Guide ​

Service Overview ​

Service Features ​

Legal Requirements ​

Key Scenarios ​

Scenario 1: Consumable Status Update Request and Processing ​

Scenario 2: Real-time Consumable Status Query ​

Scenario 3: Consumable History Query ​

Scenario 4: Replacement Notifications and Alerts ​

Scenario 5: Maintenance Scheduling ​

Scenario 6: Cost Estimation and Quotes ​

Scenario 7: Real-time Replace Events ​

Scenario 8: Service Center Recommendations ​

Key Features ​

📱 Features to Implement in App ​

1. Consumable Status Monitoring ​

2. Replacement History ​

3. Alerts and Notifications ​

4. Maintenance Scheduling ​

5. Cost Estimation ​

6. Service Center Recommendations ​

7. Real-time Event Reception ​

🏢 Features to Implement in Call Center ​

1. Consumable Data Collection System ​

2. Replacement History Management System ​

3. Alert and Notification System ​

4. Maintenance Scheduling System ​

5. Cost Estimation System ​

6. Service Center Recommendation System ​

7. API Service Management ​

8. Security and Privacy ​

9. System Operations and Monitoring ​

10. Data Analysis and Statistics ​

Sequence Diagram ​

Replace Notification System Flow ​

API Endpoints ​

Current Consumable Status Query ​

Consumable Lifecycle Query ​

Consumable Replacement Reset ​

Consumable Recommendations Query ​

Replacement Alert Configuration ​

Data Models ​

Consumable Status Information Response ​

Replacement History Response ​

Replacement Alert Configuration Response ​

Security and Privacy ​

Authentication and Authorization ​

Data Security ​

Privacy Protection ​

Access Control ​

Exception Handling ​

Network Related ​

Sensor Related ​

Consumable Related ​

Permission Related ​

Test Setup ​

Deployment Considerations ​

App Store Registration ​

Legal Regulation Compliance ​

Vehicle Compatibility ​

Consumable Replacement Notification API Developer Guide

Service Overview

Service Features

Legal Requirements

Key Scenarios

Scenario 1: Consumable Status Update Request and Processing

Scenario 2: Real-time Consumable Status Query

Scenario 3: Consumable History Query

Scenario 4: Replacement Notifications and Alerts

Scenario 5: Maintenance Scheduling

Scenario 6: Cost Estimation and Quotes

Scenario 7: Real-time Replace Events

Scenario 8: Service Center Recommendations

Key Features

📱 Features to Implement in App

1. Consumable Status Monitoring

2. Replacement History

3. Alerts and Notifications

4. Maintenance Scheduling

5. Cost Estimation

6. Service Center Recommendations

7. Real-time Event Reception

🏢 Features to Implement in Call Center

1. Consumable Data Collection System

2. Replacement History Management System

3. Alert and Notification System

4. Maintenance Scheduling System

5. Cost Estimation System

6. Service Center Recommendation System

7. API Service Management

8. Security and Privacy

9. System Operations and Monitoring

10. Data Analysis and Statistics

Sequence Diagram

Replace Notification System Flow

API Endpoints

Current Consumable Status Query

Consumable Lifecycle Query

Consumable Replacement Reset

Consumable Recommendations Query

Replacement Alert Configuration

Data Models

Consumable Status Information Response

Replacement History Response

Replacement Alert Configuration Response

Security and Privacy

Authentication and Authorization

Data Security

Privacy Protection

Access Control

Exception Handling

Network Related

Sensor Related

Consumable Related

Permission Related

Test Setup

Deployment Considerations

App Store Registration

Legal Regulation Compliance

Vehicle Compatibility