⚙ DocBase APIドキュメント
## ホスト

`api.docbase.io`です。

## プロトコル

`https`

## APIバージョン

現在、最新のバージョンは`3`です。

## アクセストークン

全てのAPIリクエストにはDocBaseサービス内で取得したアクセストークンを`X-DocBaseToken`リクエストヘッダに付与してください。

※ **IPアクセス制限が有効になっている場合、APIリクエストも制限対象**となります。APIを実行するサーバーのIPアドレスが許可リストに含まれていない場合、有効なアクセストークンを使用していても403エラーが返されます。

### アクセストークン作成方法
設定画面の「アクセストークン」から「トークンを作成」ボタンをクリックします。

![api-token-list.png](https://image.docbase.io/uploads/f680c265-6e82-4c02-ab4f-63b94c675b0c.png =700x)

トークン名、スコープ範囲、操作対象グループ、有効期限（任意）、AI用途かどうかを指定し、「作成」ボタンをクリックします。

AI用途を選ぶと、AIの利用を許可していないグループのメモや `no-ai` タグが付いたメモが操作の対象外になります。メモの添付ファイルにも同じ制限が適用されます。AIエージェントなど、AIから公開APIを利用するトークンはAI用途で作成してください。詳しくは[DocBase AI](https://help.docbase.io/posts/3991518)をご覧ください。

![api-token-new.png](https://image.docbase.io/uploads/e438b1fa-1a50-47fd-8ed1-7a8a9287a21e.png =700x)

## データ形式

データの送受信にはJSONを利用します。
リクエストボディにJSONを含む場合は、必ず次のヘッダをリクエストに付与してください。
```
Content-Type: application/json
```

日付は`ISO 8601`形式の文字列が使われます。

## ステータスコード

下記のステータスコードを返します。

| ステータスコード | 説明 |
| :---: | --- |
| 200 | リクエスト成功 |
| 201 | メモやコメントなどの作成に成功 |
| 204 | 操作に成功したが返すべきbodyは無い |
| 400 | 不正なリクエストパラメータを指定している |
| 401 | アクセストークンの有効期限が切れている |
| 403 | アクセストークンが不正<br>または、指定チームが存在しない<br>または、チームのアクセストークン機能が無効<br>または、トークンのスコープ・操作対象グループ・AI用途の制限により許可されていない操作<br>または、ユーザーに権限の無いメモなどへの操作<br>または、IPアクセス制限で許可されていない<br>または、意味検索を指定したが、チームが意味検索を利用できない<br>または、無料トライアルが終了しているか決済が完了していないため、添付ファイルをアップロードできない |
| 404 | 存在しないURLにアクセス<br>または、指定したメモやグループなどが存在しない |
| 409 | メモ本文の部分更新で、`old_content`が指定した行の現在の内容と一致しない |
| 422 | 入力内容に問題があり保存できない<br>または、グループ数やストレージ容量の上限により作成できない<br>または、無料トライアルが終了しているか決済が完了していないため、グループを作成できない |
| 429 | 一定時間のリクエスト回数が制限を超えた |
| 500 | 不明なエラー |
| 503 | 意味検索を一時的に利用できない |

## レスポンスヘッダ

| ヘッダ名 | 説明 |
| --- | --- |
| X-RateLimit-Limit | リクエスト上限回数 |
| X-RateLimit-Remaining | X-RateLimit-Resetまでの間にリクエストを発行できる回数 |
| X-RateLimit-Reset | X-RateLimit-RemainingがX-RateLimit-Limitにリセットされる時刻のUNIX時間 |

## 利用制限
#{https://help.docbase.io/posts/3809311}

## 各種API

### ユーザ

#{2071796}

#{680809}

#{https://help.docbase.io/posts/3834797}

#{4023438}

### メモ

#{92984}

#{92980} 

#{97204} 

#{92981} 

#{4126167}

#{665804}

#{665806}

#{92982} 

### コメント
#{3809313}

#{216289} 

#{216290} 

### グッジョブ

#{4039101}

#{4039103}

#{4039105} 

### 添付ファイル

#{225804}

#{1084833}

### タグ

#{92979} 

### グループ

#{652985}

#{92978} 

#{652983}

#{665797}

#{665799}

## インポートスクリプト例

#{46868} 
#{46870} 
#{468761}

## その他サンプル

#{333555}