はじめる

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 リファレンス — 全エンドポイントのドキュメント