API 문서

저희가 직접 확보해 정리한 요율 자료를 그쪽 시스템(ERP·회계· 사내 도구)에서 바로 가져가실 수 있습니다. 사람이 화면을 보고 옮겨 적는 일을 없애기 위한 것입니다.

지금은 기존 유료 요금제에 포함되어 있습니다. 유료 이용 중이시면 추가 결제 없이 바로 쓰실 수 있습니다.

1. 키 발급

원가계산기(/imp/) → 설정 → API 키에서 발급합니다. 팀 소유자만 만들 수 있습니다.

키는 발급 순간에 한 번만 보입니다. 저희도 원문을 저장하지 않기 때문에 다시 보여드릴 수 없습니다 — 안전한 곳에 옮겨 두세요. 잃어버리면 새로 발급하고 옛 키를 폐기하시면 됩니다.

2. 인증

둘 중 편한 방식으로 키를 보내시면 됩니다.

Authorization: Bearer tv_xxxxxxxxxxxxxxxx

또는

X-API-Key: tv_xxxxxxxxxxxxxxxx

가장 먼저 해볼 것

curl -H "X-API-Key: 발급받은키" \
  https://tradecosting.com/api/v1/ping

키가 정상이면 팀 이름과 함께 ok: true가 돌아옵니다.

3. 엔드포인트

경로주는 것
GET /api/v1/ping 키가 살아 있는지 확인합니다. 연동 첫 단계에서 쓰세요.
GET /api/v1/terminals 터미널별 하역료·프리타임·경과보관료, 그리고 지정한 일수만큼 경과했을 때 터미널마다 얼마가 되는지 비교표. 산정방식(누진·소급·정액)이 달라 단순 곱셈으로는 안 나오기 때문에 계산까지 해서 드립니다.
파라미터: elapsed(경과일수, 기본 9), size(기본 40FT)
GET /api/v1/benchmarks 공표요율 기준값과, 아직 기준이 없는 항목 목록.
GET /api/v1/unpublished 공표요율이 없는 항목의 참조 범위(포워더 핸들링·D/O 발급비·BAF·CAF·CIC).
GET /api/v1/usage 이 팀이 지금까지 얼마나 썼는지. 한도에 걸리기 전에 직접 확인하세요.

4. 호출 한도

분당·하루 단위로 한도가 있습니다. 현재 한도와 사용량은 /api/v1/usage에서 확인하실 수 있습니다.

한도를 넘기면 429와 함께 얼마를 넘겼는지 알려드립니다. 업무상 더 필요하시면 말씀해 주세요 — 계정별로 늘려드릴 수 있습니다.

5. 응답이 실패할 때

코드뜻
401키가 없거나, 폐기됐거나, 잘못된 키입니다.
402유료 이용 기간이 아닙니다. 결제하시면 같은 키로 바로 됩니다.
429호출 한도를 넘었습니다. 잠시 뒤 다시 시도하세요.
503API가 일시적으로 닫혀 있습니다.

막힐 때는 왜 막혔는지를 detail에 한국어로 적어 드립니다. 코드만 보고 추측하지 않으셔도 됩니다.

6. 읽으실 때 주의

공표요율과 참조 범위는 다릅니다. /benchmarks는 공표된 기준이고, /unpublished는 공표 기준이 아예 없는 항목의 참고 범위입니다. 범위 안이라고 해서 적정하다는 뜻이 아닙니다 — 응답의 confidence를 함께 읽으세요.

요율은 고시·개정으로 바뀝니다. 청구서와 다르면 먼저 적용 요율표의 판본을 확인해 주세요.

7. 안 여는 것

다음은 일부러 열지 않았습니다.