⚙ DocBase APIドキュメント ## ホスト `api.docbase.io`です。 ## プロトコル `https` ## APIバージョン 現在、最新のバージョンは`3`です。 ## アクセストークン 全てのAPIリクエストにはDocBaseサービス内で取得したアクセストークンを`X-DocBaseToken`リクエストヘッダに付与してください。 ※ **IPアクセス制限が有効になっている場合、APIリクエストも制限対象**となります。APIを実行するサーバーのIPアドレスが許可リストに含まれていない場合、有効なアクセストークンを使用していても403エラーが返されます。 ### アクセストークン作成方法 設定画面の「アクセストークン」から「トークンを作成」ボタンをクリックします。 ![fb08303e-2ed8-4245-8124-0654f69611ea-960x573r.png](https://image.docbase.io/uploads/4c36faef-a6b4-4f61-a40b-2ace6f87f260.png =WxH) トークン名、スコープ範囲の選択、有効期限の設定(任意)をして「作成」ボタンをクリックします。 ![6be6463b-4d46-4054-9c0f-4cdd78ab2f9a-960x509r.png](https://image.docbase.io/uploads/c6fa53f4-741a-4ca3-afcf-0abb164900bc.png =WxH) ## データ形式 データの送受信にはJSONを利用します。 リクエストボディにJSONを含む場合は、必ず次のヘッダをリクエストに付与してください。 ``` Content-Type: application/json ``` 日付は`ISO 8601`形式の文字列が使われます。 ## ステータスコード 下記のエラーコードを返します。 | ステータスコード | 説明 | | :---: | --- | | 200 | リクエスト成功 | | 201 | メモの投稿に成功 | | 204 | 操作に成功したが返すべきbodyは無い | | 400 | 不正なリクエストパラメータを指定している | | 403 | アクセストークンが不正
または、指定チームが存在しない | | 404 | 存在しないURLにアクセス | | 429 | 一定時間のリクエスト回数が制限を超えた | | 500 | 不明なエラー | ## レスポンスヘッダ | ヘッダ名 | 説明 | | --- | --- | | X-RateLimit-Limit | リクエスト上限回数 | | X-RateLimit-Remaining | X-RateLimitResetまでの間にリクエストを発行できる回数 | | X-RateLimit-Reset | X-RateLimitRemainingが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}