Authentifizierung
Alle Surt-API-Aufrufe erfordern einen API-Schlüssel zur Authentifizierung.
API-Schlüssel holen
- Melden Sie sich in Ihrem Surt Dashboard an
- Navigieren Sie zu Einstellungen → Entwickler
- Kopieren Sie Ihren API-Schlüssel
API-Schlüssel verwenden
Übergeben Sie Ihren API-Schlüssel im Authorization-Header jeder API-Anfrage:
Authorization: Bearer YOUR_API_KEY
Beispiel:
cURL
curl --location 'https://api.surt.com/faceguard/session/portal' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"workflow_id": "YOUR_WORKFLOW_ID",
"customer": {
"customer_id": "user_123"
}
}'
Workflow-ID
Neben Ihrem API-Schlüssel benötigen Sie eine workflow_id, um Verifizierungssessions zu erstellen:
- Gehen Sie in Ihrem Dashboard zu FaceGuard → Workflows
- Erstellen Sie einen Workflow oder verwenden Sie den Standard-Workflow
- Kopieren Sie die
workflow_id
Der Workflow definiert die Verifizierungskonfiguration für Ihre Nutzer (Liveness-Stufe, Bypass-Richtlinien usw.).
Token-Typen
FaceGuard verwendet drei Token-Typen:
| Token | Erstellt von | Verwendet von | Zweck |
|---|---|---|---|
| API-Schlüssel | Dashboard | Ihr Backend | API-Aufrufe authentifizieren |
| Portal-Token | POST /faceguard/session/portal | Ihr Frontend | FaceGuard initialisieren (30 Min. Gültigkeit) |
| Session-Token | POST /faceguard/session | FaceGuard-App intern | Session-Operationen authentifizieren |
Ihr Backend verwendet den API-Schlüssel, um Portal-Tokens zu erstellen. Ihr Frontend übergibt den Portal-Token an FaceGuard. Session-Tokens werden intern von FaceGuard verwaltet.
Umgebungen
| Umgebung | Basis-URL |
|---|---|
| Produktion | https://api.surt.com |
warnung
Halten Sie Ihren API-Schlüssel geheim. Geben Sie ihn niemals in clientseitigem Code preis. Alle API-Aufrufe sollten von Ihrem Backend aus erfolgen.