Autenticação
Todas as chamadas à API da Surt requerem uma chave API para autenticação.
Obter a sua chave API
- Inicie sessão no seu Painel Surt
- Navegue até Definições → Programador
- Copie a sua chave API
Usar a sua chave API
Inclua a sua chave API no cabeçalho Authorization de cada pedido à API:
Authorization: Bearer YOUR_API_KEY
Exemplo:
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"
}
}'
ID de fluxo de trabalho
Além da sua chave API, precisa de um workflow_id para criar sessões de verificação:
- No seu painel, vá a FaceGuard → Fluxos de trabalho
- Crie um fluxo de trabalho ou use o predefinido
- Copie o
workflow_id
O fluxo de trabalho define a configuração de verificação para os seus utilizadores (nível de deteção de vivacidade, políticas de bypass, etc.).
Tipos de token
O FaceGuard usa três tipos de token:
| Token | Criado por | Usado por | Finalidade |
|---|---|---|---|
| Chave API | Painel | O seu backend | Autenticar chamadas à API |
| Token de portal | POST /faceguard/session/portal | O seu frontend | Inicializar o FaceGuard (expira em 30 min) |
| Token de sessão | POST /faceguard/session | App FaceGuard internamente | Autenticar operações de sessão |
O seu backend usa a chave API para criar tokens de portal. O seu frontend passa o token de portal ao FaceGuard. Os tokens de sessão são geridos internamente pelo FaceGuard.
Ambientes
| Ambiente | URL base |
|---|---|
| Produção | https://api.surt.com |
aviso
Mantenha a sua chave API em segredo. Nunca a exponha em código do lado do cliente. Todas as chamadas à API devem ser feitas a partir do seu backend.