로그인이 필요합니다.

개발가이드(ver2.0)

기본 개요

nosnos API는 기본적으로 REST 방식으로 json 형태로 요청의 응답을 처리합니다.

기본 REST method 역할

GET 조회 요청 처리
POST 등록 처리
발급된 api access key 와 api scret key 를 이용하여 signature 를 생성하여 api request 인증 절차를 진행하게 됩니다.
Signature 생성규칙은 인증 챕터에서 다시 자세히 설명 드리겠습니다.

Request Host

Sandbox napi.nosnos.kr
LIVE napi.nosnos.kr
원활한 연동 테스트를 위해 sandbox 제공하오니 실제 Live 로 적용전 충분한 테스트 후 적용하시길 권장드립니다.

Throttling 이슈

API 서버의 처리 기능 향상을 위해 요청 횟수에 대한 제한이 있을 수 있으며, 제한이 생기는 서비스에 대해서는 별도 공지와 API 문서의 업데이트로 알려드리오니 사전에 API 연동 프로그램 제작시 요청 횟수를 가능한 최소한으로 작업을 하시길 권장드립니다.

API 사용권한

API 사용권한은 고객사와 물류사로 분리되어 있으며 각 API 서비스 명세에서 확인할 수 있습니다.

Request URI 기본 규칙

구분 Method URI
기본 /v2/{기본구분코드}/{세부구분코드}
등록(단일) POST /v2/{기본구분코드}/{세부구분코드}
수정 PUT /v2/{기본구분코드}/{세부구분코드}/{PK}
조회(단일) GET /v2/{기본구분코드}/{세부구분코드}/{PK}
등록(벌크) POST /v2/{기본구분코드}/{세부구분코드복수형}
조회(벌크) GET /v2/{기본구분코드}/{세부구분코드복수형}

조회(벌크) 등록 dataObject

컬럼명 자료형 설명
request_data_list dataList 처리 데이터 리스트

처리 method별 요청 본문 특이사항

처리구분 Method 특이사항
등록(단일) POST 등록 대상 data object
수정 PUT 수정 대상 data object
조회(단일) GET 없음
등록(벌크) POST dataList는 등록 대상 data object 의 list 형태
조회(벌크) GET 검색조건 data

기본 응답 포맷

컬럼명 자료형 설명
code string 응답코드
message string 메세지
response dataObject 응답 본문

조회(벌크) 응답 dataObject

컬럼명 자료형 설명
total_count integer 전체 갯수
total_page integer 전체 페이지
current_page integer 현재 페이지
data_list dataList 데이터 리스트

등록(벌크) 응답 dataObject

컬럼명 자료형 설명
processed_count integer 처리 갯수
processed_data_list dataList 처리 데이터 리스트
Top