카테고리 API

단일 카테고리 정보 조회 API

오너클랜의 단일 카테고리 정보를 조회합니다.
모든 최상위 카테고리의 상위 카테고리는 "ROOT"라는 이름을 가지며, 코드는 "00000000"입니다.
이를 이용해 최상위 카테고리만 전부 가져오거나, 모든 카테고리를 가져올 수 있습니다.

파라미터

key (ID): 조회할 카테고리의 key입니다. 오너클랜 카테고리 코드와 동일한 문자열입니다.

반환 데이터

key (String): 카테고리의 오너클랜 코드입니다.
id (String): 카테고리의 API ID입니다.
name (String): 카테고리의 이름입니다.
fullName (String): 카테고리의 전체 이름입니다. 상위 카테고리까지 포함된 이름입니다.
attributes ([String]): 카테고리 속성 정보입니다.
parent (Category): 상위 카테고리입니다. (key, id, name을 조회 가능)
children ([Category]): 하위 카테고리 목록입니다. (key, id, name을 조회 가능)
ancestors ([Category]): 상위 카테고리 전체 목록입니다. (key, id, name을 조회 가능)
descendants (CategoriesConnection): 하위 카테고리 전체 목록과 pagination 정보를 포함합니다.

Pagination 관련 파라미터

after (String): 해당 cursor 값 이후의 카테고리만 불러옵니다.
before (String): 해당 cursor 값 이전의 카테고리만 불러옵니다.
first (Int): 처음 몇 개의 카테고리를 불러올지 설정합니다.
last (Int): 마지막 몇 개의 카테고리를 불러올지 설정합니다.

        /**
        * 단일 카테고리를 조회하는 예제 쿼리입니다.
        */
        
        var client = new XMLHttpRequest();
        var query = `query {
          category(key: "50000108") {
            key
            name
            parent {
              key
              name
              parent {
                key
                name
              }
            }
            children {
              key
              name
            }
            ancestors {
              key
              name
            }
            descendants(first: 100) {
              pageInfo {
                hasNextPage
                hasPreviousPage
                startCursor
                endCursor
              }
              edges {
                cursor
                node {
                  key
                  name
                }
              }
            }
          }
        }`;
        
        client.open("POST", "https://api-sandbox.ownerclan.com/v1/graphql", true);
        client.setRequestHeader("Content-Type", "application/json");
        client.setRequestHeader("Authorization", "Bearer YOUR_TOKEN");
        
        client.onreadystatechange = function () {
            if (client.readyState === 4 && client.status === 200) {
                console.log(client.responseText);
            }
        };
        
        client.send(JSON.stringify({
            query: query
        }));