Design & Error Codes

API Design

1. Path

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

/{version}/multichain/{API resource}
//EXAMPLE: /v1/multichain/lookupEntities

• version: API의 버전을 명시합니다. (예시) v1
• multichain: Multichain API 엔드포인트임을 나타내는 고정 세그먼트입니다.
• resource: 각 API의 리소스가 정의되는 파트로, 계층 구조로 구성됩니다.

2. Response Format

모든 Multichain API의 응답은 Object 형태로 반환되며, 정상 응답(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"
}

3. Error Response Format

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

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

Error Code Specification