⚡ 5分クイックスタート
アカウント作成から最初のデータ保存まで。コピペで動きます。
1
アカウントと API キーを作る
ターミナルで CLI を使うのが最速です(サインアップ → プロジェクト作成 → キー発行まで一気に完了):
terminal
npx @nanobase/cli init
ブラウザ派は Console からサインアップして、プロジェクト作成 → API キー発行でも同じです。クレジットカードは不要です。
🔑 キーは2種類あります:
np_secret_*(サーバー専用。ブラウザから送ると拒否されます)と
np_publishable_*(ブラウザ用・読み取り専用・許可オリジン限定)。以下の書き込み例はサーバー側で secret
キーを使ってください。
2
curl で最初のリクエスト
コレクションを作って、レコードを1件保存して、読み出します:
terminal
export NANOBASE_API_KEY=np_secret_... # 手順1で発行したキー
# コレクション作成
curl -X POST https://api.nanobase.cc/v1/data/collections \
-H "X-API-Key: $NANOBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "todos"}'
# レコード保存
curl -X POST https://api.nanobase.cc/v1/data/todos \
-H "X-API-Key: $NANOBASE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"title": "nanobase を試す", "done": false}'
# 一覧取得
curl https://api.nanobase.cc/v1/data/todos \
-H "X-API-Key: $NANOBASE_API_KEY"
レスポンスは全て
{"success": true, "data": ...}
形式です。これだけでスキーマレスな JSON データベースとして使えます。
3
SDK で書く (TypeScript)
terminal
npm install @nanobase/sdk
index.ts
import { createClient } from '@nanobase/sdk';
const nb = createClient({ apiKey: process.env.NANOBASE_API_KEY! });
type Todo = { title: string; done: boolean };
const todos = nb.collection<Todo>('todos');
await todos.create({ title: 'SDK からも保存', done: false });
const list = await todos.list({ where: { done: false }, limit: 20 });
console.log(list);
認証 (nb.auth)、ファイルストレージ (nb.storage)、通知 (nb.notico)
も同じクライアントから使えます。
次のステップ
-
📖
API リファレンス (Swagger)
認証・ストレージ・通知を含む全エンドポイント
- 📦
-
🎛️
Console ダッシュボード
使用量・API キー・プランの管理