시작하기

DANGER

이 API는 현재 베타 버전입니다. 엔드포인트, 파라미터, 응답 형식은 사전 공지 없이 언제든지 변경될 수 있습니다.

YouViCo API를 사용하면 팀의 프로젝트, 버전, 댓글을 읽고 상호작용하는 통합을 여러분의 도구나 워크플로우에서 직접 구축할 수 있습니다.

API로 할 수 있는 일:

• 워크스페이스 내 프로젝트와 버전 검색 및 조회
• 버전에 댓글 읽기 및 작성
• 이모지 반응 추가 또는 제거
• 버전의 리뷰 상태 업데이트

모든 API 접근은 특정 워크스페이스에 범위가 지정된 API 키로 인증됩니다.

기본 URL

모든 요청은 다음 주소로 전송됩니다:

https://api.youvico.com/api

예를 들어, 프로젝트를 검색하려면:

GET https://api.youvico.com/api/projects.search

API 키 발급

YouViCo 앱에서 설정 → API 키로 이동하여 새 키를 생성하세요. 설명하기 쉬운 이름을 지정하고 접근할 워크스페이스를 선택하세요.

WARNING

API 키는 생성 시 단 한 번만 표시됩니다. 페이지를 벗어나면 다시 확인할 수 없습니다. 즉시 복사하여 안전한 곳에 보관하세요.

비밀로 유지하세요 — 클라이언트 측 코드나 공개 저장소에 절대 노출하지 마세요. 키가 유출된 경우 즉시 삭제하고 새 키를 발급하세요.

인증

모든 요청의 Authorization 헤더에 Bearer 토큰으로 API 키를 포함하세요:

Authorization: Bearer YOUR_API_KEY

요청 형식

API는 REST 규칙을 따릅니다. 엔드포인트는 JSON을 받고 반환합니다.

본문이 있는 요청(POST, PATCH, DELETE)에는 Content-Type 헤더를 설정하세요:

Content-Type: application/json

일반적인 요청은 다음과 같습니다:

curl -X POST 'https://api.youvico.com/api/versions/:id/comments' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ "content": "Looks great, approved." }'

응답 형식

모든 응답은 JSON을 반환합니다. 성공한 응답은 결과를 data 필드로 감쌉니다:

{
  "data": {
    "id": "bdbff5de-96d7-468f-9db0-85fe28bd6b62",
    "name": "Launch Campaign"
  }
}

목록 엔드포인트는 data를 배열로 반환하며, 페이지네이션을 위한 page 객체도 함께 반환합니다:

{
  "data": [ ... ],
  "page": {
    "current": 1,
    "hasNext": true
  }
}

일부 엔드포인트(상태 업데이트, 반응)는 성공 시 본문 없이 204 No Content를 반환합니다.

에러 응답

문제가 발생하면 API는 적절한 HTTP 상태 코드와 JSON 에러 본문을 반환합니다:

{
  "statusCode": 404,
  "message": "Not found"
}

전체 에러 코드 목록은 에러 및 요청 제한을 참고하세요.

타입 표기

API 레퍼런스 속성은 다음 표기 방식을 사용합니다:

표기	의미
string	필수이며 null이 아닌 값
string?	Nullable — 값이 null일 수 있음
필수: 아니오	Omittable — 요청에서 해당 필드 또는 파라미터를 생략할 수 있음

다음 단계

• 인증 — 워크스페이스 접근 및 키 권한
• 에러 및 요청 제한 — 에러 코드와 스로틀링
• 페이지네이션 — 오프셋 및 커서 페이지네이션
• API 레퍼런스 — 전체 엔드포인트 문서