API & SDK

ASAP REST API

기업 사용자 인증 후 배송 접수, 조회, 취소 및 관세율 조회를 연동할 수 있는 외부 REST API 문서입니다.

Endpoints

7

Base URL

https://api.asapx.ai

Language Header

lang: ko | en

Auth Cookie

accessToken

Response 기준

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

HTTP status first
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

요청 파라미터 또는 body 값 검증에 실패했습니다.

1016

ETC_ERROR

분류되지 않은 기타 오류입니다.

Authentication

REST API 사용을 위한 기업 사용자 인증과 세션 종료 API입니다.

REST 인증 API

기업 사용자 계정으로 인증합니다. 성공 시 응답 헤더 Set-Cookie에 accessToken이 포함되며, 이후 요청은 Cookie 헤더에 accessToken을 포함해야 합니다.

Request Body

id

required

string

기업 사용자 아이디

sample_api_user

pw

required

string

기업 사용자 비밀번호

samplePassword1!

Response

success

boolean

API 성공 여부

true

message

string

전달 메시지

API가 정상 처리되었습니다

errorCode

number

에러 코드

0

data

object

인증 사용자 정보

cURL

curl -X POST "$BASE_URL/v1/rest/auth" \
  -H "Content-Type: application/json" -H "lang: ko" \
  -d '{"id":"sample_api_user","pw":"samplePassword1!"}'

Request Example

{
  "id": "sample_api_user",
  "pw": "samplePassword1!"
}

Response Example

{
  "success": true,
  "message": "API가 정상 처리되었습니다",
  "errorCode": 0,
  "data": {
    "userType": 1,
    "userId": 1,
    "id": "sample_api_user",
    "email": "sample.user@example.com",
    "name": "홍길동"
  }
}

Delivery

배송 접수, 수정, 취소, 조회 API입니다.

Tariff

국가와 HS Code 기반 관세율 조회 API입니다.