API 사용안내

웹 API(애플리케이션 프로그래밍 인터페이스)는 JavaScript가 브라우저 및 외부 서비스와 상호 작용할 수 있도록 하는 내장 기능을 제공합니다. 이 섹션에서는 API를 포함한 물류정보 연동 API를 다룹니다.

API Usage Information

pi는 발급 받은 key를 api 주소에 key 쿼리 파라미터에 입력하여 환경설정합니다.

분류	설명
Api url	https://openapi.watanow.com/[PATH]?key={{License Api Key}}

Request Information

모든 api에 요청하는 공통 방식에 대한 설명이다.

Parameters

Params	설명
pageno	페이지 번호 (0이나 값이 없는 경우 전체 리스트 출력)

Method

METHOD	요청 종류	설명
GET	Query Parameter	데이터 요청 시 사용
POST	Json Body	데이터 저장/입력 시 사용
PATCH	Json Body	데이터 수정/변경 시 사용
DELETE	Query Parameter	데이터 삭제 시 사용

POST, PATCH Json Request BODY

[
	{
		"itemName": "",
		"itemCode": ""
	}
	, {} …
]

Response Information

모든 api요청 후 응답 방식에 대한 설명입니다.

Response parameter

Parameter	Type	Value
status	Integer	상태 값
message	String	결과 값에 대한 해설
data	Json Object	요청한 데이터를 json으로 보여준다.
size	Integer	페이지 블럭 수
number	Integer	현재 페이지 번호 - 1
totalElements	Integer	데이터 총 수
totalPages	Integer	전체 페이징 수
timeStamp	timestamp	응답 시간

Response JSON Example

{
	"status": 200
	, "message": "OK"
	, "data": {
		"content":[{
		…
		},{}…]
		, "page": {
			"size": 20,
			"number": 0,
			"totalElements": 29,
			"totalPages": 2
		}
	}
	, "timeStamp": 1744894076865
}

Response status Information

요청결과의 상태 값은 공통적으로 적용되는 코드입니다.

2XX - Success of some kind
4XX - Error occurred in client’s part
5XX - Error occurred in server’s part

Response status

상태코드	설명
200	Success
201	Created
202	Accepted (Request accepted, and queued for execution)
400	Bad request
401	Authentication failure
403	Forbidden
404	Resource not found
405	Method Not Allowed
409	Conflict
412	Precondition Failed
413	Request Entity Too Large
500	Internal Server Error
501	Not Implemented
503	Service Unavailable

The Fetch API allows JavaScript to make network requests asynchronously, commonly used for retrieving data from APIs.

Compatibility and Performance

카테고리 등록

Join our Community Forum

Any other questions? Get in touch