택배 API 연동이 복잡하고 어렵다고 생각하시나요? DeliveryAPI를 사용하면 회원가입부터 첫 API 호출까지 단 5분이면 완료됩니다.
💡 이 가이드를 따라하면
• 10개 택배사를 하나의 API로 통합
• 실시간 배송 조회 구현
• 배송 등록 자동화
• 웹훅으로 실시간 알림 수신
• 10개 택배사를 하나의 API로 통합
• 실시간 배송 조회 구현
• 배송 등록 자동화
• 웹훅으로 실시간 알림 수신
1단계: 회원가입 (1분)
DeliveryAPI는 이메일 인증으로 간편하게 가입할 수 있습니다.
- 회원가입 페이지로 이동
- 이메일 주소 입력
- 이메일로 받은 6자리 인증 코드 입력
- 자동으로 API Key와 Secret Key 발급
신용카드 등록 불필요! 무료 플랜(월 100회)으로 바로 시작할 수 있습니다.
2단계: API 키 확인
이메일 인증이 완료되면 자동으로 API 키가 발급됩니다.
API Key: pk_live_xxxx
Secret Key: sk_client_minimal_xxxx
# 인증 헤더 형식
Authorization: Bearer pk_live_xxxx:sk_client_minimal_xxxx ⚠️ 보안 주의사항
• API 키는 절대 클라이언트 코드에 노출하지 마세요
• 서버 환경변수에 저장하세요
• 키가 노출되면 즉시 재발급하세요
• API 키는 절대 클라이언트 코드에 노출하지 마세요
• 서버 환경변수에 저장하세요
• 키가 노출되면 즉시 재발급하세요
3단계: 첫 API 호출 (2분)
배송 조회 예제 (JavaScript)
const axios = require('axios');
const API_KEY = 'pk_live_xxxx';
const SECRET_KEY = 'sk_client_minimal_xxxx';
async function trackDelivery() {
try {
const response = await axios.post(
'https://api.deliveryapi.co.kr/v1/tracking/trace',
{
items: [
{ courierCode: 'cj', trackingNumber: '1234567890' }
]
},
{
headers: {
'Authorization': `Bearer ${API_KEY}:${SECRET_KEY}`,
'Content-Type': 'application/json'
}
}
);
console.log('배송 결과:', response.data);
return response.data;
} catch (error) {
console.error('조회 실패:', error.response?.data);
}
}
trackDelivery(); 응답 예시
{
"isSuccess": true,
"data": {
"results": [
{
"success": true,
"data": {
"trackingNumber": "1234567890",
"courierCode": "cj",
"courierName": "CJ대한통운",
"deliveryStatus": "IN_TRANSIT",
"deliveryStatusText": "배송중",
"isDelivered": false,
"dateLastProgress": "2024-12-11 13:00:00",
"progresses": [
{
"dateTime": "2024-12-11T09:00:00",
"location": "서울 강남구",
"status": "집화처리"
},
{
"dateTime": "2024-12-11T13:00:00",
"location": "경기 용인",
"status": "간선상차"
}
]
}
}
],
"summary": {
"total": 1,
"successful": 1,
"failed": 0,
"billable": 1
}
}
} 4단계: 배송 등록 (2분)
배송 등록 예제
// 택배사 계정 연동 후 사용 가능
async function createDelivery() {
try {
const response = await axios.post(
'https://api.deliveryapi.co.kr/v1/courier/deliveries/bulk-upload',
{
courierAccountKey: 'your_courier_account_key',
items: [
{
clientOrderId: 'ORDER-001',
receiverName: '김철수',
receiverPhone1: '010-9876-5432',
receiverPhone2: '',
receiverAddress: '경기도 성남시 분당구 판교역로 235',
receiverDetailAddress: '101동 202호',
receiverZipCode: '13494',
senderName: '홍길동',
senderPhone1: '010-1234-5678',
senderPhone2: '',
senderAddress: '서울특별시 중구 세종대로 110',
senderDetailAddress: '',
senderZipCode: '04524',
productName: '노트북',
quantity: 1,
deliveryMessage: '부재시 경비실에 맡겨주세요'
}
]
},
{
headers: {
'Authorization': `Bearer ${API_KEY}:${SECRET_KEY}`,
'Content-Type': 'application/json'
}
}
);
const result = response.data.results[0];
console.log('송장번호:', result.trackingNumber);
return response.data;
} catch (error) {
console.error('등록 실패:', error.response?.data);
}
} 지원되는 택배사
cj- CJ대한통운lotte- 롯데택배hanjin- 한진택배post- 우체국택배logen- 로젠택배kyungdong- 경동택배daesin- 대신택배hapdong- 합동택배coupang- 쿠팡 로켓배송woori- 우리택배
다음 단계
기본 연동을 완료했다면 다음 기능들을 살펴보세요: