시작하기
DANGER
이 API는 현재 베타입니다. 엔드포인트, 파라미터, 응답 형식은 사전 공지 없이 언제든 변경될 수 있습니다.
YouViCo API를 사용하면 자체 도구나 워크플로우에서 팀의 프로젝트, 폴더, 파일, 댓글을 읽고 상호작용하는 연동을 구축할 수 있습니다.
API로 할 수 있는 일:
- 프로젝트를 검색하고 폴더와 파일을 조회
- 폴더와 파일 생성, 수정, 삭제
- 파일 댓글 읽기와 작성
- 이모지 리액션 추가와 삭제
- 파일 리뷰 태그 업데이트
모든 API 접근은 특정 워크스페이스에 연결된 API 키로 인증합니다.
Base URL
모든 요청은 다음 URL로 보냅니다.
https://api.youvico.com/api프로젝트 검색 예시:
GET https://api.youvico.com/api/projects/searchAPI 키 발급
YouViCo 앱의 Settings → API Keys 에서 새 키를 생성합니다. 용도를 알아볼 수 있는 이름을 지정하고 접근할 워크스페이스를 선택하세요.
WARNING
API 키는 생성 시 한 번만 표시됩니다. 페이지를 벗어나면 다시 조회할 수 없습니다. 즉시 복사해서 안전한 곳에 보관하세요.
키는 비밀 정보입니다. 클라이언트 코드나 공개 저장소에 노출하지 마세요. 키가 유출되면 삭제하고 새 키를 발급하세요.
인증
모든 요청의 Authorization 헤더에 API 키를 Bearer 토큰으로 포함합니다.
Authorization: Bearer YOUR_API_KEY로컬 워크플로우에는 CLI 사용
터미널 작업이나 빠른 확인에는 YouViCo CLI를 설치하고 API 키를 로컬에 저장하세요.
npm install -g @youvico/cli
youvico auth api인증 후에는 API 레퍼런스의 CLI 탭 예시를 그대로 실행할 수 있습니다.
youvico project search --query "launch"설정, 명령 그룹, 파일 업로드, 스크립트 사용법은 CLI 가이드를 참고하세요.
쉽게 시작하려면 SDK 사용
서버 사이드 JavaScript 또는 TypeScript로 연동을 만든다면 JavaScript SDK로 시작하세요. SDK가 인증 헤더, 타입이 있는 요청 파라미터와 응답 타입, 에러 처리, 멀티파트 업로드 흐름을 대신 처리합니다.
pnpm add @youvico/apiimport { Client } from "@youvico/api";
const client = new Client({
apiKey: process.env.YOUVICO_API_KEY!,
});
const projects = await client.projects.search({
query: "launch",
});설치, 클라이언트 옵션, 업로드 헬퍼, 에러 처리는 SDK 가이드를 참고하세요.
요청 형식
API는 REST 관례를 따릅니다. 엔드포인트는 JSON 을 받고 JSON을 반환합니다.
본문이 있는 요청(POST, PATCH, DELETE)에는 Content-Type 헤더를 설정하세요.
Content-Type: application/json일반적인 요청은 다음과 같습니다.
curl -X POST 'https://api.youvico.com/api/files/:id/comments' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{ "content": "Looks great, approved." }'응답 형식
본문이 있는 성공 응답은 결과를 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 | 해당 타입의 필수 non-null 값 |
string? | nullable — 값이 null일 수 있음 |
| Required: No | 생략 가능 — 요청에서 필드 또는 파라미터를 생략할 수 있음 |