O acesso a API do HubSoft deve ser liberado para que outras aplicações/softwares possam consumir dados do sistema, como por exemplo, dados de clientes, atendimentos, ordem de serviço, financeiro, etc.
A liberação desse acesso deve ser realizado com bastante cautela, sempre validando com o integrador quais são os dados que o mesmo necessita de acesso. Dessa forma, a liberação pode ser realizada utilizando o sistema de permissionamento do HubSoft para garantir que somente os dados essenciais sejam consumidos da API.
Para criação do usuário, vamos até o menu lateral, opção Configuração > Geral > Usuários, conforme imagem abaixo:
Ao acessar a lista de usuário clique no botão de Adicionar, no canto superior direito da tela, conforme imagem abaixo:
Preencha os dados de nome do usuário, email e crie uma senha bem forte (inclua em sua senha letras maiúsculas, letras, números, caracteres especiais e letras minúsculas).
Com tudo preenchido, clique em salvar.
Importante: anote o usuário e senha utilizados, pois vamos precisar deles para enviar para o integrador. Após o usuário criado não será possível visualizar a senha do mesmo. Caso tenha esquecido ou não tenha anotado, basta editar o usuário e alterar a senha.
Com o usuário criado, vamos habilitar nele o uso da API.
Na listagem de usuário, clique em editar no usuário desejado.
Na tela que abriu, vamos até a aba API e vamos ativar a API que esse usuário deverá ter acesso, conforme imagem abaixo:
Após habilitar o acesso à API e clicar em salvar, você verá as credências (HOST, CLIENT ID e CLIENT SECRET) na interface.
Anote essas credenciais e encaminhe para o integrador, juntamente com o usuário e senha já criados na etapa anterior.
Com o usuário criado e acesso da API Habilitado, a próxima etapa é definir as permissões dos recursos que estarão acessíveis para esse usuário via API.
Importante: alinhae com o integrador, quais são os dados que ele irá consumir na API, dessa forma, o permissionamento dentro do HubSoft ficará correto e eficaz.
Após selecionar as permissões desejadas clique em salvar.
Agora basta copiar todas as credenciais criadas e as auto-geradas pelo sistema e enviar para o seu integrador.
Exemplo de uma configuração após todas as etapas acima percorridas:
- Host: api.meuservidor.com.br
- Client ID: 88721
- Client Secret: 1785jksafjkji12uuDFGAhj1246817wkjh
- Username: exemplo@usuario.com.br
- Password: %&18ejd7191639461#8hdDJH81akj!nJ_D71-jhf891
- Documentação da API: https://docs.hubsoft.com.br
Não se preocupe, se tiver qualquer dificuldade nesse processo, entre em contato com nossa equipe. Estamos preparados para lhe atender
Para consultar as credenciais de API, basta ir em Configuração > Geral > Usuários, em Ações > Editar
Vá até a aba de API, e você verá as credências (HOST, CLIENT ID e CLIENT SECRET) na interface.
Anote essas credenciais e encaminhe para o integrador, juntamente com o usuário e senha já criados na etapa anterior.