> ## Documentation Index
> Fetch the complete documentation index at: https://help.zarms.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# API キーで接続する

> チームの API キーを発行して、MCP や REST API から ZARMS を使う方法。キーの権限、有効期限、失効のしかた。

Cursor の設定ファイルや自作のスクリプト、CI など、OAuth でログインできないところから ZARMS を使うときは、チームの **API キー** を使います。同じキーで、MCP（`https://app.zarms.cloud/mcp`）と REST API（`https://app.zarms.cloud/api/v1`）の両方を呼べます。

できる人: オーナー、マネージャー（発行と失効）

## キーを発行する

**1. API キーの画面を開く**

右のナビの **設定** → **MCP 接続** を開き、**API キーによる接続（別方式）** を押します。

**2. 名前と権限を決める**

**新しいキーを発行** を押し、何に使うキーか分かる **名前** を入れます。**権限（スコープ）**
は、読むだけなら **読み取り専用**、カードの作成や更新もするなら **読み書き**
を選びます。項目ごとに参照・更新を細かく選ぶこともできます。

**3. 期限を決めて発行する**

有効期限を **無期限**・**30 日**・**90 日**・**1 年** から選び、**発行する** を押します。

**4. キーを控える**

表示されたキー（`zarms_sk_` で始まる文字列）を、安全な場所に控えます。

> [!WARNING]
>
> キーの値が表示されるのは、発行した直後の 1
> 回だけです。控え忘れたときは、そのキーを失効させて新しく発行してください。

キーを持っている人は誰でも、そのキーの権限で操作できます。必要な権限だけを付け、使い道ごとにキーを分けると、漏れたときの影響を小さくできます。

## キーを使う

リクエストのヘッダーに、次の形でキーを付けます。

```text theme={null}
Authorization: Bearer zarms_sk_...
```

Cursor での書き方は [Cursor から接続する](https://help.zarms.cloud/ja/mcp/connect-cursor.md) にあります。

REST API のエンドポイントと、MCP で使えるツールの一覧は [ZARMS API ドキュメント](https://app.zarms.cloud/api-docs) を見てください。

## キーを止める

使わなくなったキーや、漏れたおそれのあるキーは、API キーの画面で失効させます。失効させたキーはすぐに使えなくなります。

## OAuth との違い

| | OAuth | API キー |
| - | - | - |
| 向いているもの | Claude・ChatGPT などのアプリ | 設定ファイル、スクリプト、CI |
| 使える人 | 接続した本人 | キーを持っている人なら誰でも |
| チームの選び方 | 接続するときに選ぶ | 発行したチームに固定 |
| 止め方 | **設定** → **MCP 接続** で切断 | キーを失効 |

メンバーをゲストにして入れるボードを決める操作（`members:write`）は、新しく発行した「読み書き」のキーと、新しく許可した「読み書き」の OAuth 接続に含まれます。以前に発行・許可したものには付いていないので、必要なら発行し直すか、接続し直してください。

## うまくいかないとき

* **「ベーシックプランでは API / MCP を利用できません。」と出る**: API と MCP は、トライアル中かスターター以上のプランで使えます（[プランとトライアル](https://help.zarms.cloud/ja/billing/plans.md)）。
* **API キーの画面で発行のボタンがない**: 発行できるのはオーナーとマネージャーです。
* **キーで呼ぶとエラーになる**: キーが失効していないか、有効期限が過ぎていないか、必要な権限が付いているかを確かめてください。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.