はじめに

DANGER

このAPIは現在ベータ版です。エンドポイント、パラメータ、レスポンス形式は予告なく変更される場合があります。

YouViCo APIを使うと、自社ツールやワークフローからチームのプロジェクト、フォルダー、ファイル、コメントを読み取り、操作する連携を構築できます。

APIでできること:

• プロジェクトを検索し、フォルダーとファイルを取得する
• ファイルのコメントを読み書きする
• 絵文字リアクションを追加または削除する
• ファイルのレビュータグを更新する

すべてのAPIアクセスには、特定のワークスペースに紐づくAPIキーが必要です。

ベースURL

すべてのリクエストは次のURLに送信します。

https://api.youvico.com/api

プロジェクトを検索する例:

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

APIキーを取得する

YouViCoアプリの Settings → API Keys で新しいキーを作成します。用途が分かる名前を付け、アクセス対象のワークスペースを選択してください。

WARNING

APIキーは作成時に 一度だけ 表示されます。ページを離れると再表示できません。すぐにコピーし、安全な場所に保管してください。

キーは秘密情報です。クライアント側コードや公開リポジトリに含めないでください。キーが漏えいした場合は削除して新しいキーを発行してください。

認証

各リクエストの Authorization ヘッダーにBearerトークンとしてAPIキーを含めます。

Authorization: Bearer YOUR_API_KEY

リクエスト形式

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." }'

レスポンス形式

すべてのレスポンスは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 の場合があります
Required: No	省略可能 — リクエストでフィールドまたはパラメータを省略できます

次のステップ

• 認証 — ワークスペースアクセスとキー権限
• エラーとレート制限 — エラーコードとスロットリング
• ページネーション — オフセットページネーションとカーソルページネーション
• APIリファレンス — 全エンドポイントドキュメント