Autenticação
Cada solicitação à API usa um token Bearer criado no seu espaço de trabalho.
A Vergora usa chaves de API para autenticar solicitações. Envie-as de uma aplicação no servidor e passe a credencial no cabeçalho
Authorization.
Cabeçalho da solicitação
Authorization: Bearer YOUR_VERGORA_API_KEYMantenha um espaço entre Bearer e a chave de API. Não coloque uma chave de API em um parâmetro de consulta da URL.
Crie uma chave de API
- Entre no console e abra Chaves de API.
- Crie uma nova chave de API.
- Use um nome que identifique a aplicação e o ambiente, como
storefront-production. - Configure orçamento, expiração e acesso a modelos para a aplicação.
- Siga as instruções da página para copiar e armazenar com segurança a chave de API completa.
Orientações de configuração
| Configuração | Orientação |
|---|---|
| Nome | Inclua a aplicação e o ambiente |
| Ambiente | Use chaves separadas para desenvolvimento, testes e produção |
| Orçamento | Defina conforme o uso esperado; o orçamento de uma chave não adiciona fundos à carteira |
| Expiração | Use um período menor para testes temporários e revise regularmente as chaves de produção |
| Acesso a modelos | Permita apenas os modelos necessários à aplicação |
| Restrições de origem | Se ativadas, use o endereço real de saída da aplicação |
Use a chave em uma aplicação
export VERGORA_API_KEY="YOUR_VERGORA_API_KEY"Leia o valor de uma variável de ambiente no servidor ou de um gerenciador de segredos. Nunca exponha uma chave completa em código-fonte, scripts do navegador, repositórios públicos, logs ou capturas de tela.
Rotacione ou pare de usar uma chave
- Crie uma chave substituta.
- Atualize a aplicação e envie uma solicitação mínima.
- Confirme a nova solicitação em Logs de API.
- Pare de usar a chave antiga.
- Verifique se nenhuma aplicação ainda usa a credencial antiga.
Se perder a chave completa, use o processo do console para criar uma substituta. Se suspeitar de exposição, pare imediatamente de usar a credencial afetada e revise os registros de solicitações relacionados.
Solução de problemas de autenticação
| Verificação | Ação recomendada |
|---|---|
| A chave está vazia ou incompleta | Recarregue a variável de ambiente no servidor |
| O cabeçalho é inválido | Use Authorization: Bearer <key> |
| A chave expirou ou não está ativa | Verifique o status e crie uma substituta |
| O orçamento ou o escopo de modelos bloqueia a solicitação | Revise a política da chave e o modelo selecionado |
| A origem da solicitação não é permitida | Confirme o endereço real de saída da aplicação |
Para uma primeira integração, conclua primeiro o Início rápido.