Authentifizierung
Erfahren Sie, wie Sie Ihre Anfragen an die Qamaq API mit API-Schlüsseln authentifizieren.
API-Schlüssel
Die Qamaq API verwendet API-Schlüssel zur Authentifizierung von Anfragen. API-Schlüssel sind an Ihre Organisation gebunden und können verschiedene Berechtigungsbereiche haben, um zu steuern, welche Aktionen sie ausführen können.
Halten Sie Ihre API-Schlüssel sicher
Teilen Sie Ihre API-Schlüssel niemals in öffentlichen Repositories, clientseitigem Code oder anderen öffentlich zugänglichen Orten. Behandeln Sie sie wie Passwörter.
API-Schlüssel erstellen
Um einen API-Schlüssel zu erstellen:
- 1Melden Sie sich in Ihrem Qamaq-Dashboard an
- 2Navigieren Sie zu Konfigurationen > API-Schlüssel
- 3Klicken Sie auf "Neuen API-Schlüssel erstellen"
- 4Geben Sie Ihrem Schlüssel einen aussagekräftigen Namen und wählen Sie die entsprechenden Berechtigungsbereiche
- 5Kopieren Sie Ihren API-Schlüssel und speichern Sie ihn sicher — er wird nicht erneut angezeigt
API-Schlüssel verwenden
Fügen Sie Ihren API-Schlüssel im Authorization-Header mit dem Bearer-Schema ein:
cURL
curl -X GET "https://api.qamaq.io/api/v1/me" \
-H "Authorization: Bearer qmq_your_api_key"JavaScript
const response = await fetch('https://api.qamaq.io/api/v1/me', {
method: 'GET',
headers: {
'Authorization': 'Bearer qmq_your_api_key'
}
});
const data = await response.json();Python
import requests
response = requests.get(
'https://api.qamaq.io/api/v1/me',
headers={'Authorization': 'Bearer qmq_your_api_key'}
)
data = response.json()API-Schlüssel-Berechtigungsbereiche
API-Schlüssel können verschiedene Berechtigungsbereiche haben, die steuern, auf welche Ressourcen sie zugreifen können:
| Scope | Description |
|---|---|
entities:read | Entitäts-Schemas und Datensätze lesen |
entities:write | Entitäts-Datensätze erstellen und ändern |
knowledge:read | Ordner und Dateien aus der Wissensdatenbank lesen |
knowledge:write | Ordner und Dateien erstellen und ändern |
boards:read | Boards und Tickets lesen |
boards:write | Boards und Tickets erstellen und ändern |
Authentifizierungsfehler
Wenn die Authentifizierung fehlschlägt, erhalten Sie eine der folgenden Fehlermeldungen:
401Nicht autorisiert
Es wurde kein API-Schlüssel angegeben oder das Schlüsselformat ist ungültig.
403Verboten
Der API-Schlüssel ist gültig, hat aber keine Berechtigung für die angeforderte Ressource oder Aktion.
Best Practices
- Verwenden Sie Umgebungsvariablen zum Speichern von API-Schlüsseln, kodieren Sie sie niemals fest ein
- Erstellen Sie separate API-Schlüssel für verschiedene Anwendungen oder Umgebungen
- Verwenden Sie die minimal erforderlichen Berechtigungsbereiche für jeden API-Schlüssel
- Rotieren Sie API-Schlüssel regelmäßig für bessere Sicherheit
- Überwachen Sie die API-Schlüssel-Nutzung in Ihrem Dashboard
- Widerrufen Sie sofort alle API-Schlüssel, die möglicherweise kompromittiert wurden