Overview

Nodit Powerful APIs Overview

Nodit의 강력한 Web3 Data API와 인덱싱 데이터 등을 활용하여 이더리움, 폴리곤과 같은 Public 블록체인을 빠르고 쉽게 연동할 수 있습니다. Web3 제품 개발을 위한 다양한 API 들을 살펴보고 바로 적용해보세요.

Web3 Data API

Nodit은 다양한 Public 체인의 Data를 유저가 쉽고 편리하게 연동하여 사용할 수 있도록 다양한 API를 제공하고 있습니다. Nodit에서 Web3 Data API를 이용할 수 있는 환경은 다음과 같습니다.

아래 링크를 클릭하여 Web3 Data API를 이용해 보세요!

Nodit Web3 Data API 확인하기

API Design

1. Path

Nodit Web3 Data API의 Path는 공통적으로 아래와 같이 구성됩니다.

/{version}/{protocol}/{network}/{API resource}
//EXAMPLE: /v1/ethereum/mainnet/accounts

• version: API의 버전을 명시합니다. (예시) v1
• protocol: 호출 대상 블록체인 환경의 프로토콜을 명시합니다.
• network: 호출 대상 블록체인 환경의 네트워크를 명시합니다.
• resource: 각 API의 리소스가 정의되는 파트로, 계층 구조로 구성됩니다.

2. Listing & Paging

API의 응답이 목록 형식의 데이터를 포함하는 경우 아래와 같이 count와 items항목을 활용하여 목록의 크기와 데이터를 구분하여 정의합니다. 또한 대부분의 목록 응답에 대해서는 Paging을 위한 Query Parameter 사용을 지원합니다. 자세한 파라미터 사용법에 대해서는 아래 테이블을 참고하세요.

3. Response Format

모든 Nodit Web3 Data API의 응답은 Object 내에 Data를 포함하는 형태이며 응답이 단건이 아닌 Nodit Web3 Data API의 응답은 pagination 필드를 포함합니다.

정상 응답(HTTP 상태코드가 2XX인 경우)의 경우 응답 Body 내부에 실제 응답 객체가 도메인 응답의 형태로 반환됩니다.

정상 응답이 아닌 경우, message필드가 code필드와 함께 응답 내에 포함됩니다. 발생한 오류에 대한 설명을 포함합니다.

성공과 실패 각 케이스에 대한 응답 예시는 다음과 같습니다.

// Successful response with 2XX http status code (single record)
{
  requested domain response will be included here 
}

// Successful response with 2XX http status code (mutiful record)
{
  "count": int,
	"cursor": "string", // or "page": 1
	"rpp": int,
	"items": [
		{
      requested domain response will be included here 
    }
  ]
}


// Error response
{
   "code":"RESOURCE_NOT_FOUND",
   "message":"The error message will be include here"
}

4. Error Response Format

오류가 발생한 경우 응답은 아래와 같은 형식으로 반환됩니다. code와 message는 발생한 에러 타입에 따라 다른 값으로 반환되며, code 명세에 대해서는 아래 Error Code Specification을 참고하세요.

{
   "code":"${CODE}",
   "message":"${ERROR_DESCRIPTION}"
}

Error Code Specification

JSON-RPC Error Code Specification