APIs - Tutoriais

LoginWithKey

688 views 26/02/2020 28/10/2021 sergio-souza 0

LoginWithKey

Realiza login com chave e segredo informados pelo usuário. Como resultado, irá gerar os tokens de autenticação necessários para a invocação das demais APIs da plataforma senior X.

Para gerar a sua chave de acesso, utilize o gerenciamento de aplicações.

Payload de entrada
{
  "Obrigatório: Chave da aplicação"
  accessKey: string
  "Obrigatório: Segredo da chave informada"
  secret: string
  "Obrigatório: Nome do tenant em que se deseja efetuar o login"
  tenantName: string
  "Opcional: Escopo do token da autenticação. Se não for informado será usado o valor padrão 'desktop'"
  scope : string
}
Request
$ curl --location --request POST https://api.senior.com.br/platform/authentication/anonymous/actions/loginWithKey --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ 'accessKey': '{access_key}', 'secret': '{secret}', 'tenantName': '{tenant_name}' }"
Response
  • 200 Ok
{
  "String contendo um json com o token de acesso e tempo de validade do token de acesso"
  jsonToken: string
}
  • 400 Requisição Inválida
{
  "message": "Request invalid format",
  "errorCode": "loginWithKeyResponse",
  "reason": "BAD_REQUEST",
  "domain": "platform",
  "service": "authentication"
}
  • 401 Não Autorizado
{
  "message": "Usuário e/ou senha inválido.",
  "errorCode": "loginWithKeyResponse",
  "reason": "UNAUTHORIZED",
  "domain": "platform",
  "service": "authentication"
}

Este artigo foi útil para você?