Developer Docs

ASAP REST API

기업 계정 인증 후 배송 접수, 수정, 취소, 조회와 요금 조회를 연동하기 위한 외부 REST API 문서입니다. 연동 계정 신청부터 운영 전환 체크리스트까지 연계사가 바로 구현할 수 있는 기준을 함께 제공합니다.

Endpoints

9

Base URL

https://api.asapx.ai

Dev URL

https://dev-api.asapx.ai

Language

lang: ko | en

Auth Cookie

accessToken

Updated

2026-06-17

Quick Start Guide

연계사는 아래 순서대로 테스트하면 인증, 요금 조회, 배송 접수, 사후 조회까지 한 흐름으로 검증할 수 있습니다.

1

REST API 사용 신청

REST API 연동 계정과 사용 권한은 info@asapx.ai로 신청합니다. 기업계정 회원가입에 필요한 희망 아이디, 담당자명, 이메일, 연락처를 함께 전달합니다.

REST API 사용 신청 메일 작성하기
2

인증 토큰 발급

POST /v1/rest/auth 호출 후 Set-Cookie로 전달되는 accessToken을 이후 요청 Cookie 헤더에 포함합니다.

3

요금 조회

POST /v1/rest/pricing으로 국가 코드와 물품 중량/부피를 전달하고 options[].transportType, estimatedAmount를 확인합니다.

4

배송 접수

POST /v1/rest/delivery에서 요금 조회 결과로 선택한 transportType과 estimatedAmount를 deliveryGlobal에 전달합니다.

5

운영 검증

GET /v1/rest/delivery로 접수 결과를 확인하고, 수정/취소 가능 상태와 실패 응답을 함께 테스트합니다.

공통 요청 규칙 (Global Request Headers)

인증 (Authentication)

Cookie: accessToken=...

언어 (Language)

lang: ko 또는 lang: en

본문 (Content-Type)

Content-Type: application/json

코드표 및 조건부 입력

API별 필드 설명과 함께, 연계사가 구현 중 반복해서 확인하는 코드값과 조건부 입력 규칙을 모았습니다.

transportType

1: 항공(퍼스트)

2: 항공(비즈니스-DHL)

3: 항공(이코노미-UPS)

4: 해운

5: 항공(FEDEX)

6: 항공(EMS)

7: 항공(ASAP)

volumeInputType

1: width/depth/height로 CBM 계산

2: cbm 값을 직접 전달

countryCode

ISO 3166-1 alpha-2 형식

예: KR, JP, US

KR -> KR은 국내 배송, 그 외 조합은 해외 배송

공통 헤더

Content-Type: application/json

lang: ko 또는 lang: en

Cookie: accessToken=발급받은_토큰값

응답 처리 기준

REST API는 HTTP status를 우선 기준으로 처리합니다. 응답 body의 errorCode는 상세 원인 파악을 위한 ASAP 내부 코드입니다.

HTTP status first

성공 판정

HTTP status가 2xx이고 body.code가 0이면 정상 처리로 간주합니다. 응답 data가 비어 있을 수 있으므로 code를 우선 확인합니다.

요청 오류

400 계열은 필수값 누락, 형식 오류, 상태 제한 등 클라이언트 보정 대상입니다. errorCode와 message를 사용자/운영 로그에 함께 남깁니다.

인증 오류

401/403은 accessToken 만료, 권한 미부여, 쿠키 누락을 먼저 확인합니다. 토큰 재발급 후 동일 요청을 재시도합니다.

서버 오류

5xx는 즉시 무한 재시도하지 않고 지수 백오프를 적용합니다. 반복 발생 시 요청 시각, path, HTTP status, errorCode로 문의합니다.

200

OK

성공

201

Created

배송 접수 성공

400

Bad Request

요청 값 검증 실패

필수값 누락

날짜/형식 오류

401

Unauthorized

인증 정보 없음

accessToken 없음/만료/유효하지 않음

403

Forbidden

본인 배송이 아님

REST API 사용 권한 없음

기업 계정이 아님

비활성/승인 전 계정

404

Not Found

배송 없음

계정 없음

409

Conflict

현재 상태에서 처리 불가

접수 신청 상태가 아니라 수정 불가

이미 취소된 배송

결제 완료/추가결제 상태라 취소 불가

500

Internal Server Error

서버 내부 오류

처리 결과 확인 불가

ASAP errorCode 목록

0

SUCCESS

요청이 정상 처리되었습니다.

1000

NO_DATA_ERROR

조회 대상 데이터가 존재하지 않습니다.

1001

REQUIRE_SIGNIN_ERROR

로그인이 필요하거나 인증 정보가 없습니다.

1002

REQUIRE_SIGNUP_ERROR

회원가입 또는 계정 정보가 필요합니다.

1003

USER_ACTIVATE_ERROR

비활성 또는 승인 전 계정입니다.

1004

TOKEN_NOT_FOUND_ERROR

accessToken이 전달되지 않았습니다.

1005

TOKEN_INVALID_ERROR

accessToken이 만료되었거나 유효하지 않습니다.

1006

USER_PERMISSION_ERROR

요청 권한이 없습니다.

1009

ARGUMENT_NOT_VALID_ERROR

요청 값 검증에 실패했습니다.

1016

ETC_ERROR

기타 서버 처리 오류입니다.

오류 응답 예시

400 Bad Request

{
  "code": 1009,
  "name": "ARGUMENT_NOT_VALID_ERROR",
  "message": "요청 값 검증에 실패했습니다.",
  "details": [
    "phoneNum은 숫자만 전달합니다.",
    "deliveryItems는 최소 1개 이상 필요합니다."
  ]
}

401 Unauthorized

{
  "code": 1005,
  "name": "TOKEN_INVALID_ERROR",
  "message": "accessToken이 만료되었거나 유효하지 않습니다."
}

409 Conflict

{
  "code": 1016,
  "name": "ETC_ERROR",
  "message": "현재 배송 상태에서는 요청을 처리할 수 없습니다."
}

운영 연동 기준

운영 전환 전에는 성공 케이스뿐 아니라 타임아웃, 인증 만료, 중복 접수, 취소 불가 상태를 함께 검증해야 합니다.

Timeout / Retry

네트워크 오류나 5xx 응답은 동일 요청을 즉시 무한 재시도하지 말고, 지수 백오프와 운영자 확인 절차를 적용합니다.

중복 접수 방지

배송 접수 응답의 deliveryId 또는 접수번호를 저장하고, 클라이언트 타임아웃 시 조회 API로 결과를 먼저 확인합니다.

개인정보 보호

이름, 연락처, 이메일, 주소는 운영 로그와 실패 알림에 원문으로 남기지 않도록 마스킹 정책을 적용합니다.

운영 문의

연동 승인, 계정 권한, 장애 문의는 ASAP 담당 채널을 통해 API 요청 시각, path, HTTP status, errorCode를 함께 전달합니다.

Authentication

API 호출에 필요한 세션을 발급하고 종료합니다.

Delivery

배송 접수, 수정, 취소, 상세 조회를 처리합니다.

HSK Code

HS Code 6자리 기준으로 HSK 코드 후보를 조회합니다.

Pricing

배송 조건 기준으로 예상 요금을 조회합니다.

Tariff

HSK 코드와 국가 코드 기준으로 관세율 정보를 조회합니다.