Como gero uma chave API da ventic?
A integração com a plataforma ventic requer uma chave API para autenticar pedidos. Estas chaves são únicas para a sua organização e fornecem acesso seguro ao seu catálogo de produtos e serviços comerciais.
Aqui está como gerir as suas chaves API.
1. Aceder ao painel de programador
Inicie sessão na sua conta ventic e navegue até à secção Definições > Programadores (Settings > Developers). Lá encontrará o separador "Chaves API" (API Keys).
2. Gerar uma nova chave
Para criar uma nova chave:
- Clique no botão "Criar chave API" (Create API Key).
- Dê à chave um nome descritivo (ex. "Produção - Loja Principal" ou "Teste - João Silva").
- Escolha os âmbitos de permissão (Scopes). Recomendamos que conceda às chaves apenas as permissões necessárias (princípio do privilégio mínimo).
- Clique em "Gerar".
3. Armazenamento seguro da chave
Uma vez gerada, a chave ser-lhe-á apresentada apenas uma vez.
- Importante: Copie a chave e guarde-a num local seguro (ex. num gestor de passwords ou num cofre de chaves seguro na sua infraestrutura).
- Nota: Por motivos de segurança, a ventic não volta a mostrar a chave completa após o fecho da janela.
4. Utilização da chave em pedidos
Todos os pedidos para a API da ventic devem incluir a chave API no cabeçalho HTTP X-API-Key.
Exemplo de utilização com cURL:
curl -X GET "https://api.ventic.ai/v1/products" \
-H "X-API-Key: a_sua_chave_api_aqui" \
-H "Accept: application/json"
5. Rotação e eliminação de chaves
Se suspeitar que uma chave foi comprometida, deve invalidá-la imediatamente.
- No painel, selecione a chave que deseja eliminar e clique em "Revogar" (Revoke).
- Uma vez revogada, qualquer pedido que utilize essa chave será rejeitado.
- Gere uma nova chave e atualize a sua configuração.
Melhores práticas de segurança
- Nunca publique chaves API no código fonte (ex. no GitHub). Utilize variáveis de ambiente.
- Utilize chaves distintas para ambientes de teste e produção.
- Reveja regularmente a lista de chaves ativas e remova as que já não são necessárias.
Se precisar de ajuda com a integração, contacte a nossa equipa técnica em support@ventic.ai.