DK-Agora AI開発者APIを使用すると、外部アプリケーションからメモの作成、照会、暗号化/復号化ができます。APIキーを生成してRESTful APIを通じてDK-Agora AIの機能をプログラム的に活用できます。
ステップ1: 開発者ポータルへのアクセス
アドレスバーに/developerを入力するか、上部「リソース」メニューから「APIドキュメント」をクリックしてください。ログインが必要です。
ステップ2: APIキーの生成
開発者ポータルで「新規APIキーを生成」ボタンをクリックします。キー名と権限範囲を設定してください。生成されたAPIキーは一度だけ表示されるため、必ず安全な場所に保存してください。
ステップ3: APIの使用
APIリクエスト時にAuthorizationヘッダーにBearerトークンとしてAPIキーを含めます。主要エンドポイント：GET /api/v1/memos（一覧）、POST /api/v1/memos（作成）、POST /api/v1/encrypt（暗号化）、POST /api/v1/decrypt（復号化）。
ステップ4: 使用量の確認
開発者ポータルでAPI呼び出し回数、日別/月別使用量統計を確認できます。プラン別のAPI呼び出し上限を超えると429エラーが返されます。
ステップ5: APIドキュメントの参照
/developer/docsページで全APIリファレンスを確認できます。各エンドポイントのリクエスト/レスポンス形式、エラーコード、サンプルコードが提供されます。
開発者APIヒント
- -APIキーをコードに直接含めず、環境変数で管理してください。
- -使用していないAPIキーは即座に削除してください。
- -エラーレスポンスのステータスコードとメッセージを確認してデバッグしてください。
- -レートリミットに達した場合は少し待ってからリトライするか、プランのアップグレードを検討してください。