Server API 소개

Edicus Server API의 엔드포인트 레퍼런스입니다. 각 페이지에서 요청 파라미터와 응답 필드를 확인하고 바로 호출해 볼 수 있습니다.

서버용 JS SDK는 제공하지 않습니다. 이 엔드포인트들을 직접 호출하세요. 헤더와 오류 확인을 한 곳에 모으는 방법은 Server API 호출하기에 있습니다.

호스트가 둘입니다

호스트	담당
`https://api.edicus.io`	토큰, 프로젝트, 주문, 폰트
`https://resource-dot-edicusbase.appspot.com`	상품, 템플릿, 리소스

경로 앞이 /v2면 앞의 호스트, /resapi나 /manapi면 뒤의 호스트입니다.

반드시 서버에서만 호출합니다

모든 엔드포인트가 edicus-api-key 헤더를 요구합니다. 이 키는 고객사 서버에만 두고 브라우저 코드나 공개 저장소에 넣지 않습니다. 키 하나로 그 파트너의 전체 데이터에 접근할 수 있습니다.

브라우저에는 이 API로 발급받은 토큰만 내려보냅니다.

공통 헤더

헤더	언제	설명
`edicus-api-key`	항상	모션원에서 발급받은 API 키입니다
`edicus-uid`	사용자 단위 요청	고객사가 사용자에게 부여한 고유 id입니다. 형식 규칙이 있습니다
`edicus-target-uid`	복제할 때	복제본을 받을 사용자입니다. 생략하면 `edicus-uid`와 같습니다

오류는 상태 코드와 `error.code`로 판단합니다

api.edicus.io는 실패를 4xx와 5xx 상태 코드로 알립니다. body는 언제나 아래 모양 하나입니다.

{
  "error": {
    "code": "project_not_editing",
    "message": "잠정 주문은 status가 editing일 때만 가능합니다 (현재 ordering)",
    "details": { "status": "ordering", "order_id": 100023 },
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

필드	설명
`code`	snake_case 오류 코드입니다. 이 값으로 분기합니다
`message`	사람이 읽는 설명입니다. 파싱하지 않습니다
`details`	선택입니다. 검증 실패면 어긋난 항목 목록이, 상태 충돌이면 현재 상태가 들어 있습니다
`request_id`	응답 헤더 `x-request-id`와 같은 값입니다. 문의할 때 함께 알려 주세요

“요청을 처리하지 못했다”는 4xx와 5xx이고, “처리했지만 답이 아니오다”(예: can_order: false)는 200입니다. 리소스 호스트는 방식이 다릅니다. 파라미터 누락은 400, 인증 실패는 401, 그 밖의 모든 실패는 500이고, body에 error 객체가 없습니다. 엔드포인트별 오류 코드와 대응 방법은 오류 처리에 있습니다.

응답 형식

응답의 content-type은 application/json입니다.

OpenAPI 문서

api.edicus.io의 엔드포인트는 서버 코드에서 생성한 OpenAPI 3.1 문서로도 받을 수 있습니다.

https://api.edicus.io/v2/openapi.json

TypeScript라면 이 문서로 요청과 응답 타입을 만들 수 있습니다. 방법은 Server API 호출하기에 있습니다.

여기 없는 엔드포인트

이 레퍼런스는 파트너가 쓰는 엔드포인트만 담고 있습니다. Edicus 내부 운영용 엔드포인트는 다루지 않습니다. 여기 없는 경로를 호출해야 하면 문의하세요.

시작

인증

프로젝트

주문

폰트

상품

템플릿

리소스

데이터 모델

호스트가 둘입니다

반드시 서버에서만 호출합니다

공통 헤더

오류는 상태 코드와 `error.code`로 판단합니다

응답 형식

OpenAPI 문서

여기 없는 엔드포인트

다음 단계

Server API 호출하기

주문

​호스트가 둘입니다

​반드시 서버에서만 호출합니다

​공통 헤더

​오류는 상태 코드와 error.code로 판단합니다

​응답 형식

​OpenAPI 문서

​여기 없는 엔드포인트

​다음 단계

Server API 호출하기

주문

호스트가 둘입니다

반드시 서버에서만 호출합니다

공통 헤더

오류는 상태 코드와 `error.code`로 판단합니다

응답 형식

OpenAPI 문서

여기 없는 엔드포인트

다음 단계