Skip to main content

1. 요청

1-1. 요청 본문

딜리버드파트너스 API 요청은 데이터를 JSON 형태로 전송해야 합니다. 모든 요청에는 아래와 같이 Content-Type 헤더를 추가해야 합니다.
요청 본문(body)은 JSON 포맷을 따르며, API별로 요구되는 필드를 정확히 포함해야 합니다.

1-2. 인증

요청 시 HTTP 헤더에 Authorization 필드를 추가하고, 발급받은 API 키를 해당 필드에 넣어 요청하세요.

2. 응답

응답 데이터는 API 문서에 정의된 포맷에 따라 반환됩니다. 요청 성공 시 적절한 HTTP 상태 코드와 함께 결과 데이터가 반환됩니다. 요청 실패 시에도 각 상황에 맞는 HTTP 상태 코드와 에러 메시지가 포함된 응답이 반환됩니다. 응답 데이터는 항상 JSON 형태로 반환되며, HTTP 헤더에는 다음과 같은 Content-Type이 포함됩니다.

2-1. 성공 응답

성공적으로 처리된 요청에 대한 응답입니다.

2-2. 오류 응답

요청이 실패한 경우 반환되는 응답입니다.

2-3. 예외 객체

요청 실패 시, 아래와 같은 예외 객체가 반환됩니다.
string
required
HTTP 상태 코드를 나타냅니다.
string
required
에러의 사유와 관련된 설명 메시지가 포함됩니다.