Shared session

Esta é a documentação para o Handshake de Sessão CompartilhadaPersonalization. O Handshake de Sessão Compartilhada não está disponível para Autenticação.

Este método utiliza as informações de autenticação da sessão já armazenadas no navegador do seu usuário para criar uma experiência de documentação perfeita.

Implementação

1. Crie sua API de Informações

   Crie um endpoint de API que use autenticação de sessão para identificar usuários e responda com uma carga útil JSON seguindo o formatoUser.

   Se o domínio da API nãocorresponder exatamenteao domínio dos docs:

   • Adicione o domínio dos docs ao cabeçalhoAccess-Control-Allow-Originda sua API (não deve ser*)
   • Certifique-se de que o cabeçalhoAccess-Control-Allow-Credentialsda sua API sejatrue

   Essas opções de CORS só precisam ser habilitadas noúnico endpointresponsável por retornar informações do usuário. Não recomendamos habilitar essas opções em todos os endpoints do painel.

2. Configure suas configurações de Personalização

   Vá para suasdashboard settingse adicione a URL da API e sua URL de Login às suas configurações de Personalização.

Exemplos

Painel no subdomínio, docs no subdomínio

Tenho um painel emdash.foo.com, que usa autenticação de sessão baseada em cookies. Minhas rotas de API do painel estão hospedadas emdash.foo.com/api. Quero configurar a autenticação para meus docs hospedados emdocs.foo.com.

Para configurar a autenticação com o Mintlify, crio outro endpoint do paineldash.foo.com/api/docs/user-infoque identifica o usuário usando autenticação de sessão e responde com seus dados personalizados de acordo com a especificação do Mintlify. Em seguida, adicionohttps://docs.foo.comà lista de permissõesAccess-Control-Allow-Originallow-listapenas para esta rota, e garanto que minha configuraçãoAccess-Control-Allow-Credentialsesteja definida comotrue apenas para esta rota.

Em seguida, vou para as configurações do painel e insirohttps://dash.foo.com/api/docs/user-infono campo URL da API.

Painel no subdomínio, docs na raiz

Tenho um painel emdash.foo.com, que usa autenticação de sessão baseada em cookies. Minhas rotas de API do painel estão hospedadas emdash.foo.com/api. Quero configurar a autenticação para meus docs hospedados emfoo.com/docs.

Para configurar a autenticação com o Mintlify, crio outro endpoint do paineldash.foo.com/api/docs/user-infoque identifica o usuário usando autenticação de sessão e responde com seus dados personalizados de acordo com a especificação do Mintlify. Em seguida, adicionohttps://foo.comà lista de permissõesAccess-Control-Allow-Originallow-listapenas para esta rota, e garanto que minha configuraçãoAccess-Control-Allow-Credentialsesteja definida comotrue apenas para esta rota.

Em seguida, vou para as configurações do painel e insirohttps://dash.foo.com/api/docs/user-infono campo URL da API.

Painel na raiz, docs na raiz

Tenho um painel emfoo.com/dashboard, que usa autenticação de sessão baseada em cookies. Minhas rotas de API do painel estão hospedadas emfoo.com/api. Quero configurar a autenticação para meus docs hospedados emfoo.com/docs.

Para configurar a autenticação com o Mintlify, crio outro endpoint do painelfoo.com/api/docs/user-infoque identifica o usuário usando autenticação de sessão e responde com seus dados personalizados de acordo com a especificação do Mintlify.

Em seguida, vou para as configurações do painel e insirohttps://foo.com/api/docs/user-infono campo URL da API.