wv.getAuthCode - autorização de usuário de miniapp - SuperApp: Central de Documentação do Alibaba Cloud

Visão geral

O método wv.getAuthCode exibe uma janela pop-up de autorização para solicitar permissão de acesso às informações do usuário. Invoque este método apenas após o usuário compreender a necessidade da autorização. Não o invoque na tela inicial do miniapp.

O authCode retornado representa o consentimento do usuário. Seu servidor usa esse código para obter informações do usuário na plataforma, como user_id, avatar, apelido, número de celular, região, gênero e data de nascimento.

Parâmetros de solicitação

Passe um objeto com os seguintes parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
scopes	Array	Não	Escopos de autorização. Os valores válidos estão listados na tabela de escopos abaixo. O padrão é `['auth_base']`.
success	Function	Não	Callback de sucesso.
fail	Function	Não	Callback de falha.

Escopos

Cada escopo define uma permissão que o miniapp solicita ao usuário.

Escopo	Descrição	Ação no servidor
USER_ID	Obsoleto. Este escopo é um alias para `auth_base`.	Consulte `auth_base`.
USER_NICKNAME	Concede acesso ao apelido do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_NAME	Concede acesso ao nome do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_LOGIN_ID	Concede acesso ao ID de login do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
HASH_LOGIN_ID	Concede acesso ao ID de login com hash.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_AVATAR	Concede acesso ao avatar do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_GENDER	Concede acesso ao gênero do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_BIRTHDAY	Concede acesso à data de nascimento do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_NATIONALITY	Concede acesso à nacionalidade do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
USER_CONTACTINFO	Concede acesso às informações de contato do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.
auth_base	Concede acesso ao identificador único do usuário (`user_id`). Esta é uma autorização silenciosa que não exibe pop-up de autorização.	Envie o `authCode` ao seu servidor para recuperar o identificador único do usuário (`user_id`).
auth_user	Concede acesso às informações da conta do usuário.	Envie o `authCode` ao seu servidor para recuperar as informações autorizadas do usuário.

Parâmetros de resposta

O callback de sucesso recebe um objeto com as seguintes propriedades:

Propriedade	Tipo	Descrição
authCode	String	Código de autorização.
authErrorScopes	Object	Mapeia escopos com falha para seus respectivos códigos de erro.
authSuccessScopes	Array	Escopos autorizados com sucesso.

Nota

Um novo authCode é gerado sempre que o usuário concede autorização.

O callback fail recebe um objeto com as propriedades error (código de erro) e errorMessage (mensagem de erro).

Código de erro	Mensagem de erro	Solução
11	Usuário cancelou a autorização	Explique a necessidade da autorização e solicite que o usuário tente novamente.
12	Erro de rede	A solicitação de autorização falhou ou expirou. Tente novamente mais tarde.
13	Nenhum resultado de autorização encontrado	Valor inválido em `scopes`. Certifique-se de passar um array com escopos válidos.

Código de exemplo

window.WindVane.call('wv', 'getAuthCode', {scopes: ['auth_user']}, function(res) {
		authCode = res.authCode;
}, function(e) {
    alert('failure:' + JSON.stringify(e));
});