v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB
Autenticação

Autenticação com usuário e senha (fluxo legado/descontinuado)

Este serviço de login corresponde ao modelo de autenticação legado/descontinuado, que utiliza usuário e senha do SankhyaID, em conjunto com as chaves appkey e token.

Embora ainda esteja disponível para manter a compatibilidade com integrações existentes, ele foi substituído pelo novo fluxo OAuth 2.0, que oferece mais segurança e flexibilidade.

Recomendação: Planeje a migração para o novo serviço /authenticate o quanto antes, garantindo que suas integrações estejam alinhadas ao padrão atual. O serviço login permanecerá disponível, porém sem nenhuma atualização/evolução. A Sankhya indica fortemente que todas as integrações migrem para o novo modelo de autenticação /authenticate.

Para utilizar o novo fluxo, basta criar um componente do tipo integração no Portal do Desenvolvedor.

Clique aqui para ver como criar um novo componente de integração.

Fluxo recomendado:

  1. Login (/login)
  2. Chamadas subsequentes usando o bearerToken
  3. Logout (/gateway/v1/mge/service.sbr?serviceName=MobileLoginSP.logout)
  • O bearerToken deve ser enviado no cabeçalho Authorization das chamadas subsequentes.
  • Sessão expira após 30 minutos de inatividade (configurável pelo parâmetro INATSESSTIMEOUT).
  • Recomenda-se sempre realizar logout ao final.

Autentica o usuário no SankhyaOM utilizando usuário, senha, appkey e token. Retorna um bearerToken que deve ser utilizado em todas as requisições seguintes.

post/login

Headers

tokenstring required

Token obtido na tela Configurações Gateway do SankhyaOm.

appkeystring required

Chave da aplicação gerada na Área do Desenvolvedor.

usernamestring required

Usuário válido vinculado ao SankhyaID.

passwordstring password required

Senha do usuário informado.

Response

Login realizado com sucesso

bearerTokenstring

Token de sessão a ser usado no cabeçalho Authorization das chamadas subsequentes.

errorstring nullable

Informações de erro, se houver.

Example response

{
  "bearerToken": "bearerToken_da_sessao_ativa_retorna_bem_aqui"
}
All 161 operations