Criar e gerenciar chaves de API do usuário - Node.js SDK
Nesta página
Criar uma chave de API do usuário
Para criar uma novachave de API do usuário , passe um nome exclusivo entre todas as chaves de API do usuário para ApiKeyAuth.create().
const user = app.currentUser; const key = await user.apiKeys.create("apiKeyName");
Importante
Você não pode criar uma chave de API do usuário para uma chave de API do servidor ou um usuário anônimo.
Aviso
Armazenar o valor da chave de API
O SDK só retorna o valor da chave de API do usuário quando você o cria. Certifique-se de armazenar o valor key com segurança para que você possa usá-lo para se conectar.
Se você perder ou não armazenar o valor do key , não haverá como recuperá-lo. Você precisará criar uma nova chave de API do usuário.
Pesquisar uma chave de API do usuário
Para obter uma array que liste todas as chaves API de um usuário, ligue para ApiKeyAuth.fetchAll().
Para encontrar uma chave de API específica, passe o _id da chave para ApiKeyAuth.fetch().
const user = app.currentUser; // List all of a user's keys const keys = await user.apiKeys.fetchAll(); // Get a specific key by its ID const key = await user.apiKeys.fetch("5eb5931548d79bc784adf46e");
Habilitar ou desabilitar uma chave de API
Para ativar ou desativar uma chave de API do usuário, passe o _id da chave para ApiKeyAuth.enable() ou ApiKeyAuth.disable(). Quando uma chave está desativada, ela não pode ser usada para fazer login em nome do usuário.
// Get the ID of a User API Key const user = app.currentUser; const apiKeys = await user.apiKeys.fetchAll(); const keyId = apiKeys[0]["_id"]; // Enable the User API Key await user.apiKey.enable(keyId); // Disable the User API Key await user.apiKey.disable(keyId);
Excluir uma chave de API
Para excluir permanentemente uma API de usuário, passe o _id da chave para ApiKeyAuth.delete(). As chaves excluídas não podem ser recuperadas.
// Get the ID of a User API Key const user = app.currentUser; const apiKeys = await user.apiKeys.fetchAll(); const keyId = apiKeys[0]["_id"]; // Delete the User API Key await user.apiKey.delete(keyId);