인증
API 키 전달 위치와 안전한 관리 방법을 설명합니다.
모든 공개 API는 Console에서 발급한 API 키 원문을 사용합니다. endpoint에 따라 전달 위치가 다릅니다.
| Endpoint | 전달 위치 | 이름 |
|---|---|---|
/api/v1/companylist | query string | t_key |
/api/v1/trackingInfo | query string | t_key |
/api/v1/key/usage | request header | key |
Query 인증
SweetTracker 호환 endpoint는 t_key query parameter를 사용합니다. 값을 직접 문자열로 이어 붙이지 말고
HTTP client의 URL encoding 기능을 사용하세요.
curl --get "$TAEKMANI_BASE_URL/api/v1/companylist" \
--data-urlencode "t_key=$TAEKMANI_API_KEY"Header 인증
이용량 endpoint는 key header를 사용합니다.
curl "$TAEKMANI_BASE_URL/api/v1/key/usage" \
--header "key: $TAEKMANI_API_KEY"보안 수칙
- API 키는 client-side JavaScript와 mobile application에 포함하지 말고 신뢰할 수 있는 server에서 사용합니다.
- query 인증 URL을 access log, analytics, error report에 기록하지 않도록 민감정보 masking을 설정합니다.
- 키를 제3자에게 전달하거나 공개 저장소에 commit하지 않습니다.
- 유출이 의심되면 해당 키 사용을 중단하고 새 이용권과 키를 발급합니다.
유효하지 않거나 종료된 키로 호환 API를 호출하면 오류 101이 반환됩니다. 이용량 endpoint에서 키를
찾지 못하면 HTTP 404가 반환되며 response body는 보장하지 않습니다.