¶ Credenciais de API
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.
¶ Gerar Usuário de API
Passo a passo de como criar um usuário de API.
¶ 1. Criar Usuário
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.
¶ 2. Habilitar Uso da API
Com o usuário criado, vamos habilitar nele o uso da API.
Na listagem de usuário, clique em ações > 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.
¶ 3. Definir Permissões do Usuário de API
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: alinhe 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.
¶ 4. Encaminhar Credenciais
Agora basta copiar todas as credenciais criadas e as auto-geradas pelo sistema e enviar para o seu integrador.
- Host: Copiar da aba API na edição do usuário
- Client ID: Copiar da aba API na edição do usuário
- Client Secret: Copiar da aba API na edição do usuário
- Username: Email do usuário, definido no cadastro do usuário
- Password: Senha do Usuário, definido no cadastro do usuário
- Grant Type: Palavra «password»
- Documentação da API: https://docs.hubsoft.com.br
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
- Grant Type: password
- 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
¶ Consultar Credenciais de API
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.
¶ Perguntas/Problemas Frequentes
Abaixo serão listadas algumas perguntas/problemas frequentes relacionados a API. Caso alguma dessas situações aconteça e você tenha dificuldades para resolver, não hesite em chamar nosso suporte, pois estamos aqui para lhe ajudar.
¶ Por que esta ocorrendo erro de credenciais de API?
Quando ocorre este tipo de erro, seria relacionado aos dados que foram enviados ao integrador, onde podem ter sido enviados de forma incorreta.
Para resolver essa questão, crie uma nova senha e copie todos os dados de acesso e envie novamente para o integrador, sendo eles:
- client_id, client_secret, username e password
¶ Por que o usuário de API não esta conseguindo consultar determinada informação?
Usuários de API precisam ter permissões para conseguir executar as consultas necessárias, neste caso, será preciso analisar se o usuário da API posssui a permissão específica para o tipo de consulta que esta executando.