# Edicus Makers

> Edicus 편집기 연동, 템플릿 제작, Edicus Link 운영을 위한 문서 센터

- [Edicus Makers](https://make.edicus.io/docs/index.md): Edicus 편집기를 연동하고, 템플릿을 만들고, Edicus Link를 운영하는 분들을 위한 문서 센터입니다.
- [빠른 시작](https://make.edicus.io/docs/quickstart.md): 편집기를 내 화면에 띄우기까지 가장 짧은 경로
- [큰 그림](https://make.edicus.io/docs/concepts/architecture.md): 편집기가 내 사이트에 들어오는 방식과 세 참여자가 주고받는 것
- [토큰과 API 키](https://make.edicus.io/docs/concepts/authentication.md): 두 자격 증명이 각각 무엇을 할 수 있고 어디에 두어야 하는지
- [설치와 진입점](https://make.edicus.io/docs/sdk/install.md): @edicus/sdk의 세 가지 임포트 경로와 언제 무엇을 쓰는지
- [편집기 띄우기](https://make.edicus.io/docs/sdk/launch.md): 편집기 띄우기 메서드와 공통 옵션
- [세션 API](https://make.edicus.io/docs/sdk/session.md): 이벤트를 받고 커맨드를 보내는 방법
- [편집기 이벤트](https://make.edicus.io/docs/sdk/events.md): 편집기가 보내는 이벤트와 payload
- [편집기 커맨드](https://make.edicus.io/docs/sdk/commands.md): 편집기로 보낼 수 있는 커맨드와 payload
- [닫기와 저장 후처리](https://make.edicus.io/docs/sdk/exit.md): 저장 반영이 끝난 뒤에 안전하게 편집기를 닫는 방법
- [TnView와 VDP](https://make.edicus.io/docs/sdk/tnview.md): 썸네일만 가볍게 보여주고 가변 데이터를 주입하기
- [Preview 모드](https://make.edicus.io/docs/sdk/preview.md): 저장된 프로젝트를 읽기 전용으로 보여주기
- [Server API 호출하기](https://make.edicus.io/docs/server/client.md): 서버에서 Edicus HTTP API를 직접 호출하는 방법
- [주문](https://make.edicus.io/docs/server/orders.md): 잠정 주문과 확정 주문, 그리고 취소
- [VDP 주문](https://make.edicus.io/docs/server/orders-vdp.md): 가변 데이터를 실어 잠정 주문하기
- [오류 처리](https://make.edicus.io/docs/server/errors.md): 상태 코드와 error.code로 실패를 판정하는 방법
- [띄우기 옵션](https://make.edicus.io/docs/reference/launch-options.md): 편집기와 TnView와 Preview를 띄울 때 줄 수 있는 옵션
- [용어와 식별자](https://make.edicus.io/docs/reference/glossary.md): Edicus 문서에 나오는 이름들
- [SDK v2에서 옮기기](https://make.edicus.io/docs/reference/migration-from-v2.md): edicus-sdk-v2.js를 쓰던 코드를 @edicus/sdk v3으로 옮기는 두 가지 경로
- [상품 설정 한눈에 보기](https://make.edicus.io/docs/products/overview.md): Edicus Manager의 상품 설정이 편집기 동작을 어떻게 정하는지
- [상품과 ps_code 만들기](https://make.edicus.io/docs/products/create.md): Edicus Manager에서 카테고리, 상품, 사이즈를 만들고 ps_code를 얻는 방법과 상품 기본 정보
- [사이즈와 페이지 정보](https://make.edicus.io/docs/products/sizes.md): 사이즈마다 정하는 크기, 재단 여백, 안전선, 저해상도 기준
- [사이즈 고급 옵션](https://make.edicus.io/docs/products/size-options.md): 사이즈별 product override, edicus options, sizing option, material option과 부가 기능(Features)
- [탭 구성](https://make.edicus.io/docs/products/editor-tabs.md): 편집기에 보일 탭을 상품마다 고르고, 데스크톱과 모바일에서 어떻게 보이는지 확인하는 방법
- [편집기 동작](https://make.edicus.io/docs/products/editor-behavior.md): 시작 상태, 도구 버튼, 편집 제한, 충돌 검사, 경고를 상품마다 정하는 방법
- [페이지와 책등](https://make.edicus.io/docs/products/pages.md): 페이지 그룹의 모든 항목, 페이징 규칙, 책등 두께 계산과 확인 방법
- [레이아웃과 배경](https://make.edicus.io/docs/products/layout-background.md): 레이아웃 탭의 후보, 디자인을 바꿀 때 옮기고 바꾸는 범위, layout-map, 배경 탭의 선택지
- [사진과 글자 편집 범위](https://make.edicus.io/docs/products/photo-text.md): 사진 칸, 사진 보정, 사진 보관함, 글자 서식과 효과, 이름 넣기, 변수 탭에서 사용자에게 허용할 기능을 고르는 방법
- [자산: 스티커, 도형, 컷아웃, 패턴, 박, 레이어](https://make.edicus.io/docs/products/assets.md): 상품 설정 자산 그룹에서 스티커와 도형, 컷아웃, 패턴, 박(호일), 레이어 관련 기능을 정하는 방법
- [썸네일, 미리보기, 색상](https://make.edicus.io/docs/products/thumbnail-preview.md): 저장할 때 만드는 썸네일, 미리보기와 나가기 전 확인, 색상 모드, 크기 표시와 면적 계산
- [확장 설정](https://make.edicus.io/docs/products/extensions.md): 플러그인 탭, 프로모션 창, 사진 보관함 유지, 사용자 데이터를 상품마다 정하는 방법
- [리소스 관리](https://make.edicus.io/docs/products/resources.md): Resource 화면에서 편집기 자산을 찾고, 등록하고, 공개 상태를 바꾸는 방법
- [폰트](https://make.edicus.io/docs/products/fonts.md): Font 화면에서 폰트 클래스와 폰트 그룹을 만들고, 편집기 글꼴 목록에 폰트를 올리는 방법
- [스티커·패턴·디자인 관리](https://make.edicus.io/docs/products/stickers.md): Sticker, Pattern, Design 화면에서 그룹과 카테고리를 만들고 편집기에 보일 자산을 올리는 방법
- [팔레트](https://make.edicus.io/docs/products/palettes.md): Palette 화면에서 색, 박(호일), 소재를 정의하고 상품과 편집기 색 선택에 연결하는 방법
- [파트너 공통 설정](https://make.edicus.io/docs/products/style.md): Customize와 Division에서 공통 문구, CSS, 플러그인, 외부 API를 설정하는 방법
- [Customize 동작 설정](https://make.edicus.io/docs/products/customize-config.md): System, Asset, Mobile Settings의 저장 키, 기본값, 편집기에서 적용되는 동작
- [포토카드](https://make.edicus.io/docs/products/photocard.md): 여러 페이지를 그룹 단위로 편집하고 그룹마다 수량을 받아, 렌더링할 때 큰 대지에 모아 찍는 상품 설정
- [스티컷 상품](https://make.edicus.io/docs/products/sticut.md): 키링, 등신대, 스마트톡, 스티커처럼 그림 모양을 따라 칼선을 만드는 상품의 설정
- [달력 상품](https://make.edicus.io/docs/products/calendar.md): 달력 줄 설정, 시작 연월과 개월 수, 날짜 변경, Calendar 메뉴의 기념일·음력 데이터와 템플릿 준비
- [사진인화 상품](https://make.edicus.io/docs/products/photo-print.md): print 편집기의 용지, 사진 맞춤, 테두리, 날짜, 수량과 사진인화 사이즈 설정
- [렌더 옵션](https://make.edicus.io/docs/products/render-options.md): 주문된 프로젝트를 인쇄용 파일로 만들 때의 처리를 ps_code마다 정하는 렌더 엔티티 레퍼런스
- [렌더 출력 옵션](https://make.edicus.io/docs/products/render-output.md): PDF 파일 분리, 색 공간, 해상도, 주문 정보 표시, 부가 페이지, 사진인화 상품을 정하는 렌더 엔티티
- [화이트 레이어](https://make.edicus.io/docs/products/white-layer.md): 투명 소재나 유색 소재에 인쇄할 때 쓰는 화이트 레이어를 렌더 옵션으로 만드는 방법
- [템플릿 제작 시작하기](https://make.edicus.io/docs/templates/overview.md): InDesign 디자인을 에디쿠스에서 편집할 수 있는 템플릿으로 만드는 전체 흐름
- [익스포터 설치와 설정](https://make.edicus.io/docs/templates/install-exporter.md): 한국어판 InDesign에 Edicus Exporter를 설치하고, 로그인하고, 익스포트 아이템을 설정하는 방법
- [첫 템플릿 만들기](https://make.edicus.io/docs/templates/first-template.md): 명함 예제로 InDesign 문서 만들기부터 업로드, Demo 확인, resUri 복사까지 한 번에 따라 하기
- [레이어 이름과 개체 종류](https://make.edicus.io/docs/templates/layers.md): 레이어 이름으로 개체 종류를 정하는 규칙, 지원하는 레이어 전체, 쌓임 순서와 변환 결과
- [어노테이션](https://make.edicus.io/docs/templates/annotations.md): 레이어와 개체 이름 뒤 @ 문법으로 편집 제한, 표시, 렌더링, 후가공을 정하는 키 전체
- [예약 개체 이름과 페이지 영역](https://make.edicus.io/docs/templates/reserved-names.md): 개체 이름으로 동작이 정해지는 Image, none, PageInfo 개체와 그 밖의 예약 이름 전체
- [텍스트 프레임과 폰트](https://make.edicus.io/docs/templates/text.md): InDesign 글자를 편집 가능한 텍스트로 옮길 때의 컴포저, 폰트, 서식, 프레임 규칙
- [페이지와 상위 페이지(마스터)](https://make.edicus.io/docs/templates/pages.md): 페이지와 스프레드, 도련, 표지와 내지, 상위 페이지 서브타입, PageCaption 페이지 이름을 템플릿에서 정하는 방법
- [변수와 데이터 병합](https://make.edicus.io/docs/templates/variables.md): 글상자와 QR 코드에 변수를 만드는 두 방식, 변환 결과, 편집기와 TnView와 VDP 주문에서 쓰이는 방식
- [템플릿 업로드와 수정](https://make.edicus.io/docs/templates/upload.md): Export, Preview, Upload Template의 동작과 리소스 ID 덮어쓰기 규칙, Edicus Manager에서 확인하고 resUri를 얻는 방법
- [테스트 주문과 렌더링](https://make.edicus.io/docs/templates/test-render.md): Edicus Manager Test Order와 Prepress Manual Render로 템플릿과 렌더 옵션의 생산 결과를 확인하는 방법
- [스마트폰 케이스 예제](https://make.edicus.io/docs/templates/phone-case.md): Guide, PageInfo, Sticker, Cell, Background 레이어로 사진을 넣는 케이스 템플릿 만들기
- [Server API 소개](https://make.edicus.io/docs/api-reference/introduction.md): 엔드포인트를 직접 호출할 때 알아야 할 공통 사항
- [사용자 토큰 발급](https://make.edicus.io/docs/api-reference/auth/create-user-token.md): 브라우저에서 편집기를 띄울 때 쓸 토큰을 발급합니다. 유효기간은 1시간입니다.
- [프로젝트 목록](https://make.edicus.io/docs/api-reference/projects/list-projects.md): `edicus-uid` 사용자가 만든 모든 프로젝트의 목록을 반환합니다.
- [프로젝트 조회](https://make.edicus.io/docs/api-reference/projects/get-project.md): 프로젝트 하나의 정보를 조회합니다.
- [프로젝트 삭제](https://make.edicus.io/docs/api-reference/projects/delete-project.md): 프로젝트를 삭제합니다. 상태가 `editing`인 프로젝트(상태가 기록되지 않은 프로젝트 포함)만 삭제할 수 있습니다. 그 밖의 상태면 `409 project_not_editing`입니다.
- [프로젝트 소유자 조회](https://make.edicus.io/docs/api-reference/projects/get-project-owner.md): 프로젝트 소유자를 반환합니다. `owner`는 파트너 코드와 uid를 하이픈으로 이은 값(`{partner_code}-{uid}`)입니다.
- [프리뷰 썸네일 URL 목록](https://make.edicus.io/docs/api-reference/projects/get-preview-urls.md): 프로젝트의 프리뷰용 썸네일 이미지 URL 목록을 반환합니다. 각 항목은 jpg 파일 링크입니다.
- [프리뷰 썸네일 URL 목록 (여러 프로젝트)](https://make.edicus.io/docs/api-reference/projects/get-preview-urls-many.md): 프로젝트 여러 개의 프리뷰 URL을 한 번에 조회합니다. **한 번에 최대 25개입니다.** 26개 이상이면 `400 invalid_request`입니다.
- [프로젝트 복제 (동기)](https://make.edicus.io/docs/api-reference/projects/clone-project.md): 프로젝트를 복제하고 새 프로젝트 id와 프리뷰 썸네일 목록을 반환합니다. 복제된 프로젝트의 제목에는 `(복제됨)`이 붙습니다.
- [프로젝트 복제 (비동기)](https://make.edicus.io/docs/api-reference/projects/clone-project-async.md): 새 프로젝트 id를 `202 Accepted`로 즉시 반환하고 복제는 서버에서 계속 진행합니다. 복제 중인 프로젝트의 상태는 `cloning`이고, 끝나면 `editing`으로 바뀝니다. 상태는 프로젝트 조회로 확인합니다.
- [주문 가능 여부 확인](https://make.edicus.io/docs/api-reference/orders/can-order.md): 프로젝트가 주문 가능한 상태인지 알려줍니다. 사용자가 뒤로가기나 브라우저 강제 종료로 저장하지 못한 경우를 걸러내기 위한 것입니다.
- [잠정 주문](https://make.edicus.io/docs/api-reference/orders/create-tentative-order.md): 취소 가능한 주문을 넣습니다. 렌더링은 시작되지 않습니다. 프로젝트 상태가 `ordering`이 되고 편집 권한이 회수됩니다.
- [잠정 주문 (VDP)](https://make.edicus.io/docs/api-reference/orders/create-tentative-order-with-vdp.md): 가변 데이터를 포함한 잠정 주문을 넣습니다. 그 외에는 잠정 주문과 같습니다.
- [확정 주문](https://make.edicus.io/docs/api-reference/orders/create-definitive-order.md): 주문을 확정합니다. 프로젝트 상태가 `ordered`가 되고 인쇄용 고해상도 파일의 렌더링이 시작됩니다. **확정 이후에는 취소할 수 없습니다.**
- [주문 취소](https://make.edicus.io/docs/api-reference/orders/cancel-order.md): 주문을 취소합니다. **잠정 주문(`ordering`) 상태에서만 가능합니다.** 성공하면 프로젝트가 `editing`으로 돌아가고 사용자가 다시 편집할 수 있습니다.
- [렌더링 상태 초기화](https://make.edicus.io/docs/api-reference/orders/reset-order-as-ordered.md): 주문의 렌더링 상태를 `ordered`로 되돌립니다. 렌더링이 실패했을 때 재시도를 구현하기 위한 것으로, Edicus Manager 주문확인 탭의 rerender 기능과 같습니다. `edicus-uid`가 필요 없습니다.
- [폰트 그룹 목록](https://make.edicus.io/docs/api-reference/fonts/list-font-group-ids.md): 등록된 모든 폰트 그룹 id(font-group-id)를 반환합니다. `_default`는 목록에서 빠집니다.
- [폰트 그룹의 폰트 목록](https://make.edicus.io/docs/api-reference/fonts/list-fonts-in-group.md): 폰트 그룹에 속한 폰트 목록을 반환합니다.
- [상품 목록](https://make.edicus.io/docs/api-reference/products/list-products.md): Edicus Manager에 등록된 모든 상품과 상품 카테고리 정보를 가져온다. 상품을 카테고리별로 분류하는 것은 호출하는 쪽에서 한다.
- [상품 조회](https://make.edicus.io/docs/api-reference/products/get-product.md): 상품 하나의 정보를 가져온다.
- [상품 userData 갱신](https://make.edicus.io/docs/api-reference/products/set-product-userdata.md): 상품의 `userData` 내용을 갱신한다.
- [리소스 토큰 발급](https://make.edicus.io/docs/api-reference/templates/issue-resource-token.md): 템플릿을 식별하기 위한 토큰을 발급한다. 템플릿을 처음 등록할 때 한 번 받아 두고, 이후 업데이트할 때 계속 같은 토큰을 쓴다.
- [템플릿 패키지 업로드](https://make.edicus.io/docs/api-reference/templates/upload-template-package.md): 템플릿과 템플릿에 쓰인 모든 리소스 파일을 한 번에 등록한다. multipart/form-data로 보낸다.
- [대용량 템플릿 패키지 업로드 URL 발급](https://make.edicus.io/docs/api-reference/templates/get-template-package-upload-url.md): 32MB가 넘는 템플릿 패키지를 올릴 수 있는 URL을 발급받는다. **발급받은 URL은 30분 동안만 유효하다.**
- [템플릿 패키지 업로드 완료 통지](https://make.edicus.io/docs/api-reference/templates/notify-template-package-uploaded.md): 발급받은 업로드 URL에 파일을 성공적으로 올렸음을 알리고 등록을 완료한다. **이 호출까지 성공해야 템플릿 업로드가 끝난 것이다.**
- [템플릿 미리보기 변환](https://make.edicus.io/docs/api-reference/templates/preview-template.md): InDesign 템플릿을 edicus-doc으로 변환하고 미리보기용 SVG를 받는다. 등록하지 않고 결과만 확인할 때 쓴다.
- [리소스 검색](https://make.edicus.io/docs/api-reference/resources/query-resources.md): 검색 조건으로 리소스를 조회한다.
- [리소스 개수 조회](https://make.edicus.io/docs/api-reference/resources/count-resources.md): 검색 조건에 맞는 리소스의 개수를 조회한다. 요청 형식은 리소스 검색과 같다.
- [프로젝트에 쓰인 사용자 이미지 목록](https://make.edicus.io/docs/api-reference/resources/get-user-resource-urls.md): 프로젝트에 사용된 사용자 업로드 이미지의 목록을 얻는다.
- [ErrorBody](https://make.edicus.io/docs/api-reference/models/error-body.md): Server API의 모든 오류 응답 body
- [Project](https://make.edicus.io/docs/api-reference/models/project.md): 프로젝트 조회 응답의 프로젝트 정보
- [ProjectStatus](https://make.edicus.io/docs/api-reference/models/project-status.md): 프로젝트 상태값
- [PreviewTn](https://make.edicus.io/docs/api-reference/models/preview-tn.md): 프리뷰 썸네일
- [TentativeOrderBody](https://make.edicus.io/docs/api-reference/models/tentative-order-body.md): 잠정 주문 요청 body
- [VariableDataSet](https://make.edicus.io/docs/api-reference/models/variable-data-set.md): VDP 가변 데이터
- [FontListEntry](https://make.edicus.io/docs/api-reference/models/font-list-entry.md): 폰트 그룹의 폰트 항목
- [Product](https://make.edicus.io/docs/api-reference/models/product.md): 리소스 API의 상품 정보
- [Resource](https://make.edicus.io/docs/api-reference/models/resource.md): 리소스 API의 리소스 정보
- [ResourceAuthError](https://make.edicus.io/docs/api-reference/models/resource-auth-error.md): 리소스 API의 인증 실패 응답
- [AGENTS](https://make.edicus.io/docs/AGENTS.md)

## OpenAPI Specs

- [openapi](/docs/api-reference/openapi.json)

## Optional

- [edicus.io](https://edicus.io)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.