Obter token de sessão para uma chave única conhecida

Objetivo

Permite que o cliente obtenha um token de sessão para uma chave única.

Endpoint

Endpoint	Método	Header Content-Type	Ambiente	Descrição
https://api.mosiaomnichannel.com.br/clientes/utilitarios/seguranca/chaveAuth	POST	application/json	Sandbox e produção	Devolve um token de sessão para a chave única que será repassada como parâmetro

Headers

Parâmetro	Obrigatório	Tipo	Descrição
Authorization	M	token do cliente	Token do tipo segurança
Content-Type	M	application/json	Informe este conteúdo

Parametros de entrada

Serão enviados no BODY os seguintes parâmetros:

Parâmetro	Obrigatório	Tipo	Descrição
chaveUnica	M	String	Chave única que você deseja criar a sessão.

Request:

curl --location --request POST '{dominio_mobilesaude}clientes/utilitarios/seguranca/chaveAuth' \
--header 'Authorization: {tokenApiPublica}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chaveUnica": {chaveUnica}
}'

Objetos e atributos de retorno

O retorno da API terá a seguinte estrutura:

{
    "status": true,
    "data": {
        "token": "ey333bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZFNlc3NhbyI6ImIwZTViOTc1LTA3YTQtNGYwNC04MDUwLTEzMzAxY2IwMTIxOSIsImlkT21uaUNvbnRhdG8iOiJCMkx3ZjFWSC82SW5DNVdPVU9RWUpHTGQiLCJleHBpcmFjYW8iOjE3MzIzMDQ5MTkyMTcsImF1ZCI6ImJlbmVmaWNpYXJpbyIsInZlcnNhbyI6IjIiLCJpYXQiOjE3MzIzMDMxMjB9.CGJtBDJbwFrsyahE-zuNC1waR8XZkiW0WwHef2c5ijA",
        "expireAt": 1732304919217
    },
    "message": "Beneficiário autenticado",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1732303120224
}

Repare que no exemplo acima, o status TRUE indica que a requisição foi bem sucedida. Também existe um “expireAt” que indica o prazo que o token será invalidado. O tempo de validade de token de sessão é de 30 minutos.

O uso deste token é indicado para embutir funcionalidades que necessitem de uma sessão de usuário autenticado.