인증

API 요청 인증 방법

인증

WhereParcel API는 API 키를 사용하여 요청을 인증합니다. 대시보드에서 API 키를 확인하고 관리할 수 있습니다.

API 키 받기

  1. WhereParcel 계정에 로그인
  2. 대시보드 → API 키로 이동
  3. 새 API 키 생성 클릭
  4. API 키와 시크릿 키를 안전하게 저장

:::warning ⚠️ 중요: 시크릿 키를 안전하게 저장하세요. 다시 볼 수 없습니다! :::

요청 헤더

모든 API 요청에는 다음 헤더가 포함되어야 합니다:

헤더설명
AuthorizationBearer 토큰 형식: Bearer {apiKey}:{secretKey}
Content-Typeapplication/json이어야 함

cURL 예제

curl -X POST https://api.whereparcel.com/v2/track \
  -H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trackingItems": [
      {
        "carrier": "kr.post",
        "trackingNumber": "1234567890123"
      }
    ]
  }'

Node.js 예제

const response = await fetch('https://api.whereparcel.com/v2/track', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY:YOUR_SECRET_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    trackingItems: [
      {
        carrier: 'kr.post',
        trackingNumber: '1234567890123'
      }
    ]
  })
});

const data = await response.json();

환경 변수 사용

버전 관리에 커밋되지 않도록 API 키를 환경 변수에 저장하세요:

# .env 파일
WHEREPARCEL_API_KEY=your_api_key_here
WHEREPARCEL_SECRET_KEY=your_secret_key_here

:::tip 💡 팁: .env 파일을 .gitignore에 추가하여 실수로 민감한 자격 증명을 커밋하는 것을 방지하세요. :::

보안 모범 사례

  • API 키를 공개적으로 공유하지 마세요
  • 환경 변수에 키를 저장하세요
  • 개발 및 프로덕션에 다른 키를 사용하세요
  • 정기적으로 키를 교체하세요
  • 손상된 키는 즉시 취소하세요

인증 오류 응답

인증에 실패하면 401 Unauthorized 응답을 받습니다:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key or secret key"
  }
}