API 레퍼런스

Docs SDK

TypeScript에서 Docs REST API를 호출하는 공식 npm 클라이언트를 사용합니다.

설치

bash

npm install @the-seeker/docs-sdk

SDK는 ESM 패키지이며 Node.js 18.17 이상을 지원합니다.

클라이언트 만들기

typescript

import { createDocsClient } from "@the-seeker/docs-sdk";

const apiKey = process.env.CRM_DOCS_API_KEY;
if (!apiKey) throw new Error("CRM_DOCS_API_KEY가 필요합니다.");

const docs = createDocsClient({ apiKey });
const { sites } = await docs.sites.list();

apiKeybodystring필수

docs:read 또는 docs:write 권한을 가진 조직 API 키입니다.

baseUrlbodystring기본값: https://crm.theseeker.io

API 기본 주소입니다. 테스트 환경에서만 재정의하세요.

timeoutMsbodynumber기본값: 15000

요청 제한 시간(밀리초)입니다.

페이지 생성과 경로 upsert

create는 페이지를 새로 만들고, upsertByPath는 같은 경로의 페이지가 있으면 수정합니다. 반환값의 created는 실제 생성 여부이며 warnings는 Markdown 변환 결과를 알립니다.

typescript

const result = await docs.pages.upsertByPath("site-id", "guides/start", {
  title: "시작하기",
  markdown: "## 시작하기\n\n첫 문서입니다.\n",
});

console.log(result.page.path, result.created, result.warnings);

수정 요청에서 baseRevision을 사용하면 동시에 진행된 편집을 감지할 수 있습니다. 충돌이면 페이지를 다시 읽고 변경을 합치세요.

클라이언트 메서드

영역	메서드
가이드	`authoringGuide()`
사이트	`sites.list()`, `get()`, `create()`, `update()`, `delete()`
내비게이션	`navigation.get()`, `navigation.set()`
페이지	`pages.list()`, `get()`, `getByPath()`, `create()`, `update()`, `delete()`, `upsertByPath()`
게시와 릴리스	`publish()`, `releases.list()`, `releases.restore()`

오류 처리

HTTP 요청이 실패하면 DocsApiError가 발생합니다. status는 HTTP 상태 코드, code는 서버가 돌려준 오류 코드입니다.

typescript

import { DocsApiError } from "@the-seeker/docs-sdk";

try {
  await docs.pages.create("site-id", {
    path: "guides/start",
    title: "시작하기",
    markdown: "본문\n",
  });
} catch (error) {
  if (error instanceof DocsApiError) {
    console.error(error.status, error.code);
  } else {
    throw error;
  }
}

오류 코드와 REST 응답은 Docs API를 참고하세요.

이 페이지가 도움이 되었나요?

클라이언트 만들기

typescript

import { createDocsClient } from "@the-seeker/docs-sdk";

const apiKey = process.env.CRM_DOCS_API_KEY;
if (!apiKey) throw new Error("CRM_DOCS_API_KEY가 필요합니다.");

const docs = createDocsClient({ apiKey });
const { sites } = await docs.sites.list();

apiKeybodystring필수

docs:read 또는 docs:write 권한을 가진 조직 API 키입니다.

baseUrlbodystring기본값: https://crm.theseeker.io

API 기본 주소입니다. 테스트 환경에서만 재정의하세요.

timeoutMsbodynumber기본값: 15000

요청 제한 시간(밀리초)입니다.

페이지 생성과 경로 upsert

typescript

const result = await docs.pages.upsertByPath("site-id", "guides/start", {
  title: "시작하기",
  markdown: "## 시작하기\n\n첫 문서입니다.\n",
});

console.log(result.page.path, result.created, result.warnings);

수정 요청에서 baseRevision을 사용하면 동시에 진행된 편집을 감지할 수 있습니다. 충돌이면 페이지를 다시 읽고 변경을 합치세요.

영역

메서드

가이드

authoringGuide()

사이트

sites.list(), get(), create(), update(), delete()

내비게이션

navigation.get(), navigation.set()

페이지

pages.list(), get(), getByPath(), create(), update(), delete(), upsertByPath()

게시와 릴리스

publish(), releases.list(), releases.restore()

오류 처리

HTTP 요청이 실패하면 DocsApiError가 발생합니다. status는 HTTP 상태 코드, code는 서버가 돌려준 오류 코드입니다.

typescript

import { DocsApiError } from "@the-seeker/docs-sdk";

try {
  await docs.pages.create("site-id", {
    path: "guides/start",
    title: "시작하기",
    markdown: "본문\n",
  });
} catch (error) {
  if (error instanceof DocsApiError) {
    console.error(error.status, error.code);
  } else {
    throw error;
  }
}

오류 코드와 REST 응답은 Docs API를 참고하세요.