🚪 Logout

📋 Visão Geral

O Logout é o endpoint responsável por encerrar a sessão autenticada de um cliente na API Pública.

Ele opera sobre o mecanismo de autenticação baseada em cookie — ao ser chamado com o cabeçalho Uappi-Cookie-Name, instrui o servidor a expirar o cookie de sessão do cliente no navegador.

O uso mais comum é em fluxos de saída de conta (sign-out) em frontends e aplicações checkout, garantindo que a sessão do cliente seja encerrada de forma limpa e segura.

🔄 Como Funciona

O endpoint aceita requisições sem autenticação obrigatória — o middleware PublicAuth processa o token se presente, mas não o exige.

O comportamento do logout depende diretamente da presença do cabeçalho Uappi-Cookie-Name:

Com o cabeçalho Uappi-Cookie-Name

Quando o cabeçalho é enviado, o servidor identifica o cookie de sessão pelo nome informado e o expira imediatamente, definindo uma data de expiração no passado.

O navegador do cliente remove o cookie automaticamente, encerrando a sessão de forma efetiva.

Este é o fluxo esperado para logout em aplicações frontend com autenticação baseada em cookie.

Sem o cabeçalho Uappi-Cookie-Name

Quando o cabeçalho não é enviado, o servidor não realiza nenhuma ação sobre cookies — a requisição é processada e retorna sucesso, mas nenhuma sessão é encerrada.

Este comportamento é esperado e não representa erro — apenas indica que não havia contexto de cookie para expirar.

📌 Notas e Considerações

• O endpoint não invalida tokens Bearer — sua função é exclusivamente encerrar sessões baseadas em cookie.
• O cabeçalho Uappi-Cookie-Name deve conter o nome exato do cookie de sessão que foi definido no login — valores incorretos não causam erro, mas também não encerram sessão alguma.
• A resposta é sempre 200 OK com data: true, independente de o cookie ter sido expirado ou não.

Logout

Descrição

Este endpoint realiza o encerramento da sessão autenticada do cliente.

O comportamento central é a expiração do cookie de sessão — quando o cabeçalho Uappi-Cookie-Name é enviado, o servidor instrui o navegador a remover o cookie correspondente.

Autenticação opcional

O middleware PublicAuth processa o token se presente, mas não o exige.

Chamadas sem o cabeçalho Authorization são tratadas normalmente e recebem a mesma resposta de sucesso.

Cookie de sessão

O cabeçalho Uappi-Cookie-Name informa ao servidor qual cookie deve ser expirado.

Sem esse cabeçalho, o endpoint retorna sucesso sem realizar nenhuma ação sobre a sessão — não há erro, apenas ausência de efeito.

Parâmetros

Headers

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/api/v3/logout \
3  --header 'Uappi-Cookie-Name: nome_do_cookie_aqui'

✅ Resposta de Sucesso

1{
2  "status": true,
3  "data": true
4}