checkLogin

Última atualização em 2023-05-20
  • Criado para:
  • Developer
    Admin

Verifica se um usuário com uma empresa específica (identificada pelo identificador), endereço de email e senha pode fazer logon.

OBSERVAÇÃO

Se o identificador da empresa for omitido, esse método verificará o logon do usuário padrão.

Tipos de usuário autorizados

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parâmetros

Entrada (checkLoginParam)

Nome Tipo Obrigatório Descrição
companyHandle xsd:string Não O identificador da empresa que contém o usuário.
email xsd:string Sim O endereço de email do usuário.
senha xsd:string Sim A senha do usuário.

Saída (checkLoginParam)

Nome Tipo Obrigatório Descrição
status xsd:string Sim Status de logon do usuário.

Exemplos

Este código de exemplo usa um parâmetro de identificador de empresa, endereço de email e uma senha para determinar se um usuário pode fazer logon no IPS. Se o usuário pode fazer logon, esse método retornará a string, ValidLogin. Se o usuário não é possível fazer logon, esse método retornará a string, InvalidLogin.

Solicitação

<ns1:checkLoginParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>137</ns1:companyHandle>
   <ns1:email>juser3@scene7.com</ns1:email>
   <ns1:password>welcome</ns1:password>
</ns1:checkLoginParam>

Resposta

<ns1:checkLoginReturn xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:status>InvalidLogin</ns1:status>
</ns1:checkLoginReturn>
Página anterior
Next page

Nesta página