​
1. 요청

​
1-1. 요청 본문

글로벌 쉽 API 요청은 데이터를 JSON 형태로 전송해야 합니다. 모든 요청에는 아래와 같이 Content-Type 헤더를 추가해야 합니다.

Content-Type: application/json
요청 본문(body)은 JSON 포맷을 따르며, API별로 요구되는 필드를 정확히 포함해야 합니다.

​
1-2. 인증

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

Authorization: {YOUR_API_KEY}

​
2. 응답

응답 데이터는 API 문서에 정의된 포맷에 따라 반환됩니다.

요청 성공 시 적절한 HTTP 상태 코드와 함께 결과 데이터가 반환됩니다. 요청 실패 시에도 각 상황에 맞는 HTTP 상태 코드와 에러 메시지가 포함된 응답이 반환됩니다.

응답 데이터는 항상 JSON 형태로 반환되며, HTTP 헤더에는 다음과 같은 Content-Type이 포함됩니다.

Content-Type: application/json

​
2-1. 성공 응답

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

HTTP Status설명
200요청이 성공적으로 처리되었습니다.
201요청이 성공적으로 처리되었고, 리소스가 생성되었습니다.
204요청이 성공적으로 처리되었으나 응답 본문이 없습니다.

​
2-2. 오류 응답

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

HTTP Status설명
400잘못된 요청입니다. 요청 본문에 누락된 필드가 있거나 데이터 형식이 올바르지 않을 때 반환됩니다. 요청 데이터를 다시 확인해주세요.
401인증에 실패했습니다. 시크릿 키가 없거나 잘못된 키가 사용된 경우 반환됩니다. 인증 정보를 확인해주세요.
403권한이 부족하여 요청이 거부되었습니다. 해당 요청을 수행할 권한이 있는지 확인 후 다시 시도해주세요.
404요청한 리소스 또는 URL이 존재하지 않습니다. 요청 경로 또는 리소스 식별자를 확인해주세요.
500서버에서 문제가 발생했습니다. 글로벌 쉽 서버의 내부 오류로 인해 요청이 처리되지 못했습니다. 문제가 지속되면 관리자에게 문의해주세요.

​
2-3. 예외 객체

요청 실패 시, 아래와 같은 예외 객체가 반환됩니다.

{
    "httpStatus": "UNAUTHORIZED",
    "message": "Authorization Key not found"
}
​
httpStatus
string
required

HTTP 상태 코드를 나타냅니다.

​
message
string
required

에러의 사유와 관련된 설명 메시지가 포함됩니다.

환경주문 등록