API 코드랩

이 디렉토리에는 ECARUS 텔레매티스 API를 구현하기 위한 포괄적인 실습 코드랩을 포함합니다. 각 코드랩은 실용적인 예제와 완전한 구현으로 단계별 지침을 제공합니다.

사용 가능한 코드랩

🔧 원격 엔진 제어 API

원격 엔진 시작/중지 기능을 실시간 모니터링과 안전 기능으로 구현하는 방법을 배우세요.

배울 내용:

• 원격 엔진 제어 (시작/중지)
• SSE를 통한 실시간 상태 모니터링
• 안전 및 보안 구현
• 설정 관리 및 진단
• 오류 처리 및 엣지 케이스

주요 기능:

• 기후 제어와 함께 엔진 시작/중지
• 실시간 상태 스트리밍
• 안전 검증 시스템
• 명령 기록 및 분석
• 긴급 정지 처리

---

🚨 ACN (자동 충돌 알림) API

자동 충돌 감지와 구조 서비스 통합으로 긴급 대응 조정을 마스터하세요.

배울 내용:

• 긴급 상황 감지 및 관리
• 실시간 긴급 알림
• 에이전트 워크플로 조정
• 다중 기관 긴급 대응
• 사건 보고 및 분석

주요 기능:

• 자동 충돌 감지
• 실시간 긴급 알림
• 에이전트 할당 및 워크로드 관리
• 긴급 서비스 조정
• 사건 추적 및 보고

---

🔍 수동 진단 API

동의 관리와 실시간 데이터 스트리밍으로 원격 차량 진단을 구현하세요.

배울 내용:

• 원격 진단 세션 관리
• 사용자 동의 및 보안 워크플로
• 실시간 진단 데이터 스트리밍
• DTC 코드 분석 및 보고
• 종합 진단 보고서

주요 기능:

• 원격 진단 세션
• 차량 센서의 라이브 데이터 스트리밍
• DTC (진단 트러블 코드) 분석
• 사용자 동의 관리
• 자동화된 보고서 생성

---

시작하기

각 코드랩은 독립적이며 다음을 포함합니다:

• 사전 요구 사항 - 필요한 도구 및 지식
• 설정 지침 - 프로젝트 초기화
• 단계별 구현 - 점진적 학습
• 완전한 예제 - 완전히 작동하는 애플리케이션
• 테스트 지침 - 구현 테스트 방법
• 챌린지 연습 - 고급 연습 문제

추천 학습 경로

1. 원격 엔진 제어로 시작 - 기본 API 패턴과 실시간 업데이트 학습
2. ACN으로 이동 - 긴급 워크플로와 에이전트 조정 이해
3. 수동 진단으로 완료 - 복잡한 세션 관리와 동의 플로 마스터

일반 요구 사항

모든 코드랩에 필요:

• Node.js와 npm 설치
• REST API에 대한 기본 이해
• JavaScript/TypeScript 지식
• 텍스트 에디터 또는 IDE

API 인증

모든 예제는 동일한 인증 패턴을 사용:

const authToken = 'sk_4f9c7b8e2d1a6c0f3e7a9b5d8c1e4f2a7c6d9e0b3f5a8c1d4e7f9b2c6a1e3d';
const headers = {
  'Authorization': `Bearer ${authToken}`,
  'Content-Type': 'application/json'
};

샘플 데이터

모든 코드랩은 일관된 샘플 데이터를 사용:

• VIN: KMHSH81C7LU123456
• 에이전트 ID: AGENT_001
• 기술자 ID: TECH_001

코드랩 실행

각 코드랩에는 완전히 실행 가능한 예제가 포함됩니다:

# 코드랩 디렉토리로 이동
cd codelab

# 특정 코드랩 지침 따르기
# 각 코드랩에는 자체 설정 및 테스트 단계가 있습니다

기여

이 코드랩은 포괄적인 학습 리소스로 설계되었습니다. 문제를 발견하거나 개선 제안을 하려면:

1. 정확성을 위해 기존 API 문서 확인
2. 변경 제출 전에 모든 코드 예제 테스트
3. 설정된 형식과 구조 따르기
4. 기본 및 고급 사용 사례 모두 포함

보안 모범 사례

ECARUS API를 구현할 때 항상 다음 보안 지침을 따르세요:

인증

• 모든 API 통신에 HTTPS/TLS 사용
• 적절한 토큰 관리 및 갱신 메커니즘 구현
• 클라이언트 측 코드에 인증 토큰 노출하지 않음
• 민감한 구성에 환경 변수 사용

데이터 보호

• 전송 중 민감한 차량 데이터 암호화
• 사용자 역할 기반 적절한 액세스 제어 구현
• 감사 목적으로 모든 API 액세스 로깅
• 차량 정보에 대한 데이터 보존 정책 따르기

차량 안전

• 원격 제어 전 항상 차량 안전 조건 확인
• 장기 실행 작업에 타임아웃 메커니즘 구현
• 중요한 상황에 긴급 정지 기능 제공
• 비정상 액세스 패턴 모니터링

테스트 지침

API 테스트

• 프로덕션 전에 제공된 테스트 환경 사용
• 오류 시나리오 및 엣지 케이스 테스트
• SSE 연결이 연결 해제를 정상적으로 처리하는지 확인
• 다양한 차량 모델 및 구성으로 테스트

보안 테스트

• 인증 및 권한 부여 플로 테스트
• 입력 유효성 검사 및 정화 확인
• 속도 제한 및 남용 방지 테스트
• 중요한 엔드포인트에 침투 테스트 수행

성능 테스트

• 부하 하에서 API 응답 시간 테스트
• SSE 스트리밍 성능 확인
• 동시 세션 처리 테스트
• 장기 실행 애플리케이션에서 메모리 사용량 모니터링

지원

코드랩에 대한 질문이나 문제가 있으면:

1. 먼저 API 문서 확인
2. 각 코드랩의 문제 해결 섹션 검토
3. 제공된 예제로 테스트
4. 각 구현에 표시된 오류 처리 패턴 참조

추가 리소스

• API 문서 - 완전한 API 참조
• 개발자 가이드 - 일반 개발 지침
• 보안 모범 사례 - 보안 구현 지침
• 테스트 지침 - API 테스트 모범 사례