API-Authentifizierung
Alle API v2-Anfragen erfordern eine Authentifizierung über einen Bearer-Token.
So funktioniert es
- Generieren Sie einen API-Schlüssel unter Einstellungen > API-Schlüssel
- Fügen Sie ihn in den
Authorization-Header jeder Anfrage ein:
Authorization: Bearer YOUR_API_KEY_HERE
Beispiel (cURL)
curl -X GET "https://yourdomain.com/api/v2/submissions" \
-H "Authorization: Bearer fp_key_abc123xyz789" \
-H "Accept: application/json"
Beispiel (JavaScript)
const response = await fetch('https://yourdomain.com/api/v2/submissions', {
headers: {
'Authorization': 'Bearer fp_key_abc123xyz789',
'Accept': 'application/json',
'Content-Type': 'application/json'
}
});
const data = await response.json();
Beispiel (PHP)
$client = new \GuzzleHttp\Client();
$response = $client->get('https://yourdomain.com/api/v2/submissions', [
'headers' => [
'Authorization' => 'Bearer fp_key_abc123xyz789',
'Accept' => 'application/json',
]
]);
$data = json_decode($response->getBody(), true);
Beispiel (Python)
import requests
headers = {
'Authorization': 'Bearer fp_key_abc123xyz789',
'Accept': 'application/json'
}
response = requests.get('https://yourdomain.com/api/v2/submissions', headers=headers)
data = response.json()
Sicherheit
| Funktion | Detail |
|---|---|
| Speicherung | Schlüssel werden als SHA256-Hash in der Datenbank gespeichert |
| Mandantenzuordnung | Schlüssel sind einem bestimmten Mandanten zugeordnet |
| Tracking | Der last_used_at-Zeitstempel wird bei jeder Verwendung aktualisiert |
| Ablauf | Schlüssel können optionale Ablaufdaten haben |
| Widerruf | Schlüssel können sofort über die Einstellungen widerrufen werden |
API-Schlüsselverwaltung
| Aktion | Vorgehensweise |
|---|---|
| Erstellen | Einstellungen > API-Schlüssel > Neuen Schlüssel erstellen |
| Anzeigen | Schlüsselname, Erstellungsdatum und letztes Verwendungsdatum einsehen |
| Widerrufen | Auf „Widerrufen" klicken, um einen Schlüssel dauerhaft zu deaktivieren |
warnung
Der vollständige Schlüssel wird nur einmal angezeigt, wenn er erstellt wird. Speichern Sie ihn sicher. Wenn er verloren geht, widerrufen Sie ihn und erstellen Sie einen neuen.