Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

As operações disponíveis neste serviço são:

OperaçãoDescrição
login

Recebe como cabeçalhos HTTP o nome do usuário ("username") e a senha ("password") e retorna um TOKEN JWT que deve ser utilizado para as chamadas às outras operações.

    • Suportado somente para usuários internos.


Recomendamos a utilização do serviço api/auth/accesstoken, para geração de token para usuários internos e externos.

userAndPasswordLogin

Recebe como argumentos o nome do usuário ("arg0"), senha ("arg1") e retorna um TOKEN JWT.

    • Suportado somente para usuários internos.


Recomendamos a utilização do serviço api/auth/accesstoken, para geração de token para usuários internos e externos.

logoutSession

Depreciado. TOKEN JWT expira automaticamente.

callProcedureRecebe como cabeçalho HTTP o TOKEN JWT ("usertoken") e como argumentos o nome do programa ("arg0"), o nome do procedimento ("arg1") e os parâmetros desta ("arg2").
callProcedureWithCompanyRecebe como cabeçalho HTTP o TOKEN JWT ("usertoken") e como argumentos o código da companhia ("arg0"), nome do programa ("arg1"), o nome do procedimento ("arg2") e os parâmetros desta ("arg3").
callProcedureWithTokenRecebe como argumentos o TOKEN JWT ("arg0"), o nome do programa ("arg1"), o nome do procedimento ("arg2") e os parâmetros desta ("arg3").
callProcedureWithTokenAndCompany

Recebe como argumentos o TOKEN JWT ("arg0"), o código da companhia ("arg1"), o nome do programa ("arg2"), o nome do procedimento ("arg3") e os parâmetros desta ("arg4").

Aviso
titleAviso

Verificar a configuração em Propriedades → Propriedades Gerais → WebService (Permite login WebService).

  • Caso esta propriedade não exista no banco de dados, o sistema permitirá o acesso as operações de login (login, userLogin e userAndPasswordLogin). Se houver algum valor incorreto no atributo, ocorrerá o bloqueio as operações de WebService login.

Recomendamos a utilização do serviço responsável pela geração de Token JWT de acordo com as credencias do usuário  (http://[SERVIDOR]:[PORTA]/api/auth/accesstoken)

...