APIキーの取得
Neuradex APIを使用するには、アクセスキーが必要です。
現在NeuradexはClosed Betaとして提供されています。Waitlistから登録をお申し込みください。 アクセスキーを作成
設定 → アクセスキーから、新しいキーを作成します。
アクセスキーは一度しか表示されません。安全な場所に保存してください。
クライアントの初期化
グローバルクライアント
複数プロジェクトにアクセスする場合は、グローバルクライアントを使用します。
import { NdxGlobalClient } from '@neuradex/sdk';
const global = new NdxGlobalClient({
apiKey: process.env.NEURADEX_API_KEY,
});
// プロジェクト一覧を取得
const projects = await global.listProjects();
// 特定のプロジェクトのクライアントを取得
const client = global.getProject('project-id');
プロジェクトクライアント
特定のプロジェクトのみ使用する場合は、直接プロジェクトクライアントを初期化できます。
import { NdxClient } from '@neuradex/sdk';
const client = new NdxClient({
apiKey: process.env.NEURADEX_API_KEY,
projectId: 'your-project-id',
});
認証の確認
クライアントの初期化後、認証が正しく設定されているか確認できます。
const result = await global.verifyAuth();
if (result.valid) {
console.log('認証成功');
} else {
console.error('認証失敗:', result.error);
}
環境変数
APIキーは環境変数で管理することを推奨します。
NEURADEX_API_KEY=ndx_your_api_key_here
NEURADEX_PROJECT_ID=your-project-id
本番環境では、シークレット管理サービス（AWS Secrets Manager、Vercel Environment Variablesなど）の使用を推奨します。
次のステップ
