Konfiguration

Das SDK wird über das SonarSDKConfig-Objekt konfiguriert, das an den SonarSDK-Konstruktor übergeben wird.

Optionen

Parameter	Typ	Erforderlich	Standard	Beschreibung
apiKey	string	Ja	—	Ihr Sonar API-Schlüssel. Muss mit sk_ beginnen.
instanceName	string	Nein	—	Der Sonar-Instanzname zur Konstruktion der Basis-URL.
baseUrl	string	Nein	—	Vollständige Überschreibung der API-Basis-URL. Hat Vorrang vor instanceName.
timeout	number	Nein	30000	Anfrage-Timeout in Millisekunden.
headers	Record<string, string>	Nein	{}	Zusätzliche benutzerdefinierte Header für jede Anfrage.

TypeScript-Definition

interface SonarSDKConfig {
  apiKey: string;
  instanceName?: string;
  baseUrl?: string;
  timeout?: number;
  headers?: Record<string, string>;
}

URL-Auflösung

• Wenn baseUrl angegeben ist, wird es direkt als API-Basis-URL verwendet.
• Wenn nur instanceName angegeben ist, wird die Basis-URL wie folgt konstruiert: https://session.sonar.de/{instanceName}
• Wenn keines von beiden angegeben ist, wird eine Standard-Basis-URL verwendet.

Beispiele

// Instanzname verwenden (empfohlen für Produktion)
const sdk = new SonarSDK({
  apiKey: 'sk_live_abc123',
  instanceName: 'acme-corp',
});
// Basis-URL → https://session.sonar.de/acme-corp

// Benutzerdefinierte Basis-URL verwenden (für Entwicklung/Tests)
const sdk = new SonarSDK({
  apiKey: 'sk_test_xyz789',
  baseUrl: 'https://staging.sonar.de/acme-corp',
});

// Mit benutzerdefiniertem Timeout und Headern
const sdk = new SonarSDK({
  apiKey: 'sk_live_abc123',
  instanceName: 'acme-corp',
  timeout: 60000,
  headers: {
    'X-Custom-Header': 'my-value',
  },
});