제약 사항
C
작성자: Chaehyeon Lee
1주 전에 업데이트함

1.오류 시 에러 및 상태 코드

DS-API 요청 시, 발생할 수 있는 상태 코드와 에러 코드를 설명합니다.

오류 시 응답 형태는 아래와 같으며, errorCode 는 생략될 수 있습니다.

{
"timestamp": "response 발생 시점",
"path": "request path",
"status": "http status code",
"error": "status code 설명",
"errorCode": "에러 종류"
}

아래 표에 기술된대로 오류 시 에러코드와 상태 코드가 반환됩니다.

HTTP

Status

Code

error

errorCode

설명

401

UNAUTHORIZED

SpaceID, API Key 값를 통한 credential 인증에 실패

402

PAYMENT_REQUIRED

API 기능 사용 가능 기간이 만료되어서, 구매 필요

403

FORBIDDEN

해당 키로 접근할 수 없는 리소스, 타 Space 의 리소스에 대한 접근 시도 시 발생

404

NOT_FOUND

존재하지 않는 리소스에 대한 참조 요청, 제거된 리소스에 대한 요청 시에도 반환. parameters 로 어떤 값이 존재하지 않는지 반환해준다.

429

TOO_MANY_REQUESTS

rate limit 정책 에 따라, 1초당 10건을 초과하는 요청을 시도할 경우 반환

409

DUPLICATED

중복이 허용되지 않는 UID 등에 대해 중복 아이템 생성 / 수정 시도 시 반환

400

BAD_REQUEST

INVALID_UID

생성 / 수정하려는 UID 값이 128자 이내의 영문 대소문자, 숫자, ‘_’, 로만 이루어지지 않은 경우 반환

400

BAD_REQUEST

INVALID_PHONE_NUMBER

생성 / 수정하려는 전화번호 값이 10~12자리의 숫자로만 이루어지지 않은 경우 반환

400

BAD_REQUEST

INVALID_EMAIL

생성 / 수정하려는 이메일 값이 올바르지 않은 경우 반환

400

BAD_REQUEST

INVALID_CHANNEL

응답 URL 조회 API 에서 기본링크 수집그룹이 아닌 다른 채널의 수집그룹을 요청한 경우 반환

2.요청 건수 제한 정책 (rate limit)

DS-API 요청 시, 1초당 최대 10건의 요청이 가능합니다. 10건 이상의 요청이 발생할 경우, 429 - TOO_MANY_REQUESTS 오류가 반환됩니다.

답변이 도움되었나요?