Pular para o conteúdo principal

Configuração Inicial

Permissões​

Permissões Api Request​

Para utilizar a Api Request, é necessário criar um Papel e um Usuário com Permissões de Api exclusivamente para ser utilizado nas requisições. Siga o passo a passo a seguir:

1. Criar Papel​

Crie um Papel especificadamente para utilizar na Api Request:

Super Admin >>> Papel >>> Novo >>> Preencher as Informações >>> SALVAR

Após criar o Papel, clique em Permissões:

2. Adicionar Permissões​

Clique em "Adicionar/Remover Permissões" e pesquise por "api". Selecione as seguintes Permissões:

  • PERM_API_WRITE_ACCESS

  • PERM_API_READ_ACCESS

3. Criar Usuário​

Admin >>> Usuário >>> Novo >>> Preencher Informações >>> Ativar Flag >>> SALVAR

Ao criar um usuário de Api, é necessário ativar a flag "usuario de API". Deste modo, não será exigido vincular uma Pessoa, sendo possível vincular uma Organização e um Grupo de Acesso.

4. Adicionar Papel​

Ao criar o Usuário com a flag ativada, observe que o nome do Usuário fica em destaque. Clique em "Papéis":

Clique em "Adicionar Papel" e selecione o Papel criado na etapa 1.

atenção:

Usuário de Api somente poderá ser usado em requisições. Este usuário não tem acesso ao sistema Accessus.

Configuração Inicial Postman​

Para os testes de Api Request utilizaremos nesta demonstração o Api Client Postman. Acompanhe o passo a passo para configurá-lo:

1. Download Collection​

Primeiramente, realize o download da collection: Collection Postman-Go

2. Importar Collection​

Realize a importação da collection para o Postman.

3. Variáveis de Ambiente​

Configure e selecione as variáveis de ambiente.

  • go_auth_login:
    Login (credencial) gerado pelo Portal Go.

  • go_auth_pass
    Senha gerada pelo portal Go.

  • go_account_id
    ID da conta recuperado em: "/manager/v1/accounts", para usar recursos como "/selfieregister/v1/{{go_account_id}}/invites"

info

As credenciais de login são encontradas nas configurações do sistema. Acesse: Serviço Go

4. Fluxo do Login​

Siga o fluxo de login conforme demonstrado a seguir:

1. Login Request​

/auth/v1/login/loginRequest

2. Login Challenge​

/auth/v1/login/challengeResponse