認証

Annie Insights API は、x-api-key HTTP ヘッダーを介して API キー認証を使用します。

仕組み

API キーをすべてのリクエストに HTTP ヘッダーとして含めます。

x-api-key: YOUR_API_KEY

例

curl -X POST \
  https://api.annie-insights.com/api/v2/clinical-images \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"PatientID": "P-001", "TimeStamp": "2026-05-24", "ImageName": "https://..."}'

APIキーの取得

タイプ	入手方法	使用事例
サンドボックス キー	サンドボックスページで利用可能	テストと開発
プロダクション キー	連絡先 api-support@hcds.ai	生産統合

セキュリティのベストプラクティス

警告

クライアント側のコードで API キーを公開しないでください。 API 呼び出しは常にバックエンド サーバーから行ってください。

• キーを安全に保存 — 環境変数またはシークレット マネージャーを使用する
• キーを定期的にローテーションします - 侵害が疑われる場合は、新しいキーをリクエストします
• HTTPS のみを使用 — すべての API エンドポイントには TLS 暗号化が必要です
• 使用状況を監視 — 応答ヘッダーを介してリクエスト数を追跡​​します

エラー応答

認証が失敗した場合、API は次を返します。

{
  "error": "Unauthorized",
  "message": "Invalid or missing API key",
  "statusCode": 401
}

すべてのエラー コードについては、Error Handling を参照してください。