시작하기

YouViCo API를 호출할 때 공통으로 사용하는 기본 규칙이에요.

Base URL

https://api.youvico.com

엔드포인트 문서의 경로는 모두 Base URL 뒤에 붙여서 호출해요.

예를 들어 /workspaces는 https://api.youvico.com/workspaces로 호출해요.

요청 형식

본문이 있는 요청은 JSON으로 보내요.

Content-Type: application/json

본문이 없는 요청은 Content-Type 헤더를 보내지 않아도 돼요.

경로 파라메터는 {id}처럼 중괄호로 표시해요.

쿼리 파라메터는 URL 뒤에 ?page=1&pageSize=20 형식으로 붙여요.

응답 형식

성공 응답은 엔드포인트마다 정의된 JSON 본문을 반환해요.

본문이 없는 성공 응답은 문서에 없음으로 표시해요.

{
  "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
  "name": "워크스페이스"
}

에러 형식

에러 응답은 기본적으로 message와 code를 반환해요.

{
  "message": "Forbidden resource",
  "code": "FORBIDDEN_EXCEPTION"
}

인증 상태나 2단계 인증 상태를 알려야 하는 에러는 추가 필드를 함께 반환할 수 있어요.

{
  "message": "2단계 인증이 필요해요.",
  "code": "NEED_TFA_EXCEPTION",
  "tfa": true
}

타입 표기

문서의 타입은 TypeScript 표기와 비슷하게 작성해요.

표기	의미
string	문자열
number	숫자
boolean	참 또는 거짓
object	객체
array	배열
T?	값이 null일 수 있어요.
T | undefined	필드가 생략될 수 있어요.
T? | undefined	필드가 생략되거나 null일 수 있어요.

배열의 하위 필드는 [].id처럼 표시해요.

중첩 객체의 하위 필드는 workspace.id처럼 표시해요.