Pular para o conteúdo principal
Versão: 2.2.0

Questões gerais

Qual tipo de licença é mais adequado para chamadas de API?​

O tipo da licença varia de acordo com a necessidade. Por exemplo, caso um usuário de uma licença STAFF seja utilizado como usuário de Web Service, ele não conseguirá cadastrar novos usuários pelo serviço adm_ws, já que esta é uma funcionalidade que exige uma licença mais permissiva.

Consigo consumir uma API utilizando um usuário que esteja logado?​

Sim, desde que a licença permita.

Qual a real diferença entre uma sessão de usuário "normal" e de uma API?​

A principal distinção entre uma sessão de usuário "normal" e uma de API reside na maneira como ambas consomem licenças e gerenciam suas respectivas sessões. Em ambos os casos, uma licença é consumida. Entretanto, quando um web service é chamado, este não registra sua sessão na tabela de sessões. Isto implica que um acesso por meio do /apigateway não entra em conflito com outras chamadas de web service ou API para o mesmo usuário, uma vez que nenhuma delas vai registrar uma sessão ativa.

No entanto, um cenário a ser considerado ocorre quando há apenas uma licença para usuário simultâneo e já existe um usuário logado no SoftExpert Suite visualizando um portal, por exemplo. Nessa situação, as chamadas de Web Service vão retornar um erro 403. Isso ocorre porque existe um usuário que já está consumindo a única sessão disponível de fato.

Portanto, enquanto as sessões de usuários "normais" e de API podem parecer semelhantes à primeira vista, elas têm características de gestão de licenças e sessões distintas, que devem ser levadas em conta ao projetar e implementar soluções que utilizam esses recursos.

Levando em conta estes cenários, o que é sugerido?

  1. Cadastrar um usuário específico para consumo das APIs e Web Services SOAP.
  2. Deixar apenas uma licença para este usuário. Isso é necessário, pois nos casos de chamadas externas (cuja licença não é informada), o SoftExpert Suite vai pegar a primeira que encontrar.
  3. Utilizar uma licença permissiva, de acordo com as necessidades (se deseja iniciar workflows via web service, o tipo da licença deve comportar tal funcionalidade)

Os logs das requisições enviadas para o SoftExpert Suite ficam armazenados no SoftExpert Suite?​

Os registros das requisições enviadas para o SoftExpert Suite são armazenados dentro do próprio sistema. Estes podem ser acessados por meio dos Widgets disponíveis nos elementos do componente SoftExpert Administração, os quais podem ser utilizados durante a criação de um portal. Alternativamente, esses registros também podem ser consultados através da importação de um portal personalizado do sistema.

Desta forma, tanto os administradores quanto os usuários têm a capacidade de monitorar e analisar as solicitações feitas para o SoftExpert Suite, facilitando o rastreamento de atividades e a solução de problemas potenciais.

O que preciso saber sobre as mensagens de erro da API?​

Salvo indicação em contrário, a maioria dos endpoints da SoftExpert Suite retorna uma resposta 200 OK para indicar uma operação bem-sucedida. Caso uma API ou Web Service retorne um código de status diferente, as informações específicas sobre a resposta serão detalhadas em sua respectiva documentação.

A SoftExpert Suite também possui várias respostas de erro padrão que são comuns a diversas APIs:

  • 401 Unauthorized: Esta resposta é retornada quando a autenticação fornecida é inválida. Para detalhes sobre como autenticar corretamente as solicitações de API, consulte nossa seção de autenticação e segurança.
  • 403 Forbidden: Este código é retornado quando a autenticação fornecida não detém as permissões necessárias para acessar a URL específica.
  • 429 Too Many Requests: Esta resposta é retornada quando a sua conta ou aplicativo excede os limites de taxa da API. Oferecemos sugestões sobre como operar dentro desses limites em nossa documentação.

Porque estou recebendo a mensagem Valid GatewayJWT not found in the request or user is blocked!?​

Essa mensagem geralmente é exibida quando ocorre um erro 401. Na maioria dos casos, isso indica que a API Key necessária para autenticar a solicitação não foi incluída no cabeçalho dela. É crucial garantir que a API Key esteja corretamente incorporada no cabeçalho de todas as solicitações que você envia para evitar esse erro.

Alternativamente, essa mensagem também pode surgir se o usuário usado para a integração estiver bloqueado. Nesse caso, seria necessário verificar o status do usuário e tomar as medidas necessárias para desbloqueá-lo, se for o caso.

Caso continue recebendo essa mensagem após verificar esses dois aspectos, sugerimos que você entre em contato com o suporte técnico para obter assistência adicional.

Última atualização em