Avisos e Autenticação
Entenda como se autenticar e como funciona o consumo de créditos.
Autenticação
A API Verifiky utiliza o padrão Bearer Authentication (Token de Acesso). Isso significa que você deve enviar seu token em cada requisição através do cabeçalho HTTP Authorization.
Segurança
Seus tokens de API carregam privilégios totais sobre sua conta. Nunca compartilhe eles em repositórios públicos (GitHub, GitLab) ou no código-fonte do lado do cliente (JavaScript de navegador).
Como enviar o token
Adicione o seguinte cabeçalho na sua requisição:
Authorization: Bearer seu_token_aqui_123456
Exemplo com cURL:
curl -X POST https://api.verifiky.com/api/processar \
-H "Authorization: Bearer seu_token_aqui" \
-H "Content-Type: multipart/form-data" \
...Consumo de Créditos
O modelo de cobrança da API é baseado em créditos pré-pagos. Cada operação bem-sucedida consome créditos do seu saldo.
| Ação | Custo | Quando é cobrado? |
|---|---|---|
| /processar | 1 Crédito | Apenas se o OCR e a validação facial forem concluídos com sucesso. |
| /extrair-dados | 1 Crédito | Ao retornar os dados extraídos do documento. |
Erros de Saldo (HTTP 402)
Antes de processar qualquer requisição, a API verifica se você possui saldo suficiente. Caso contrário, a operação é interrompida imediatamente e nenhum crédito é "negativado".
Resposta de Erro
{
"success": false,
"error": "Payment Required",
"message": "Saldo insuficiente para realizar esta operação. Recarregue sua conta."
}