クイックスタートガイド

CloudFlowを使い始めるための基本的なセットアップ手順を説明します。わずか数分でチームの業務管理を開始できます。

このガイドでは、CloudFlow APIの基本的な使い方を説明します。詳細なリファレンスはAPIリファレンスを参照してください。

1. APIキーの取得

CloudFlowのAPIを使用するには、まずAPIキーを取得する必要があります。ダッシュボードの設定ページからAPIキーを発行してください。

APIキーの種類

CloudFlowでは2種類のAPIキーを提供しています：

テストキー - 開発・テスト環境用。cf_test_ プレフィックス
本番キー - 本番環境用。cf_live_ プレフィックス

APIキーは機密情報です。公開リポジトリにコミットしたり、クライアントサイドのコードに含めないでください。

2. 最初のAPIリクエスト

APIキーを取得したら、最初のリクエストを送信してみましょう。以下はcurlを使った例です。

curl -X GET https://api.cloudflow.jp/v1/projects \
  -H "Authorization: Bearer cf_test_xxxxxxxxxxxx" \
  -H "Content-Type: application/json"

レスポンス例

{
  "data": [
    {
      "id": "proj_abc123",
      "name": "Webアプリ開発",
      "status": "active",
      "created_at": "2026-01-15T09:00:00Z",
      "members_count": 5,
      "tasks_count": 24
    },
    {
      "id": "proj_def456",
      "name": "モバイルアプリ",
      "status": "active",
      "created_at": "2026-02-01T10:30:00Z",
      "members_count": 3,
      "tasks_count": 18
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 20
  }
}

3. タスクの作成

プロジェクトにタスクを作成するには、以下のエンドポイントを使用します。

curl -X POST https://api.cloudflow.jp/v1/projects/proj_abc123/tasks \
  -H "Authorization: Bearer cf_test_xxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "API設計書の作成",
    "description": "REST APIの設計書をOpenAPI形式で作成する",
    "assignee_id": "user_123",
    "priority": "high",
    "due_date": "2026-03-15"
  }'

4. SDKの使用

CloudFlowでは、主要な言語向けに公式SDKを提供しています。

JavaScript / TypeScript

npm install @cloudflow/sdk

import { CloudFlow } from '@cloudflow/sdk';

const client = new CloudFlow({
  apiKey: process.env.CLOUDFLOW_API_KEY
});

// プロジェクト一覧を取得
const projects = await client.projects.list();

// タスクを作成
const task = await client.tasks.create('proj_abc123', {
  title: 'API設計書の作成',
  priority: 'high',
  due_date: '2026-03-15'
});

Python

pip install cloudflow-sdk

from cloudflow import CloudFlow

client = CloudFlow(api_key=os.environ["CLOUDFLOW_API_KEY"])

# プロジェクト一覧を取得
projects = client.projects.list()

# タスクを作成
task = client.tasks.create(
    project_id="proj_abc123",
    title="API設計書の作成",
    priority="high",
    due_date="2026-03-15"
)

5. Webhook設定

Webhookを使用すると、CloudFlow内のイベントをリアルタイムで受け取ることができます。ダッシュボードの設定 > Webhookから、エンドポイントURLとイベントタイプを設定してください。

対応イベント

task.created - タスクが作成された時
task.updated - タスクが更新された時
task.completed - タスクが完了した時
project.created - プロジェクトが作成された時
member.added - メンバーが追加された時

Webhookペイロードの例

{
  "event": "task.completed",
  "timestamp": "2026-03-09T14:30:00Z",
  "data": {
    "task_id": "task_789",
    "project_id": "proj_abc123",
    "title": "API設計書の作成",
    "completed_by": "user_123"
  }
}

次のステップ

基本的なセットアップが完了しました。さらに詳しい使い方については、以下のガイドを参照してください。