Como Autenticar em um Portal

O processo de autenticação e liberação de um portal deve ser realizado previamente antes de enviar integrações. Cada portal possui seu próprio método de autenticação, e é importante entender as particularidades de cada um.

Métodos de Autenticação

Cada portal de integração pode utilizar diferentes métodos de autenticação. Os métodos mais comuns são:

1. Usuário e Senha

A maioria dos portais trabalha com autenticação tradicional usando usuário e senha. Neste método, você precisa fornecer as credenciais de acesso que você possui no portal (geralmente as mesmas que você usa para acessar o site do portal).

2. Tokens de Acesso

Alguns portais utilizam tokens de acesso para autenticação. Neste caso, você precisa gerar ou obter um token específico no portal e fornecer esse token durante o processo de autenticação.

3. OAuth (Autenticação Moderna)

Portais mais modernos utilizam o sistema OAuth para criar o token de autenticação da loja. O OAuth é um protocolo de autorização que permite que aplicações terceiras acessem recursos do usuário sem expor suas credenciais diretamente.

O fluxo OAuth geralmente envolve:

• Redirecionamento para uma página de autorização do portal
• Autorização pelo usuário
• Recebimento de um código de autorização
• Troca do código por um token de acesso

API: registrar ou atualizar credenciais no Loja Conectada

Para persistir na plataforma as credenciais da loja em um portal (usuário, senha, tokens, URL de estoque etc.), use o endpoint abaixo. O portal_id na URL é o identificador do portal no catálogo (Integradorsite), o mesmo retornado em Portais ativos (catálogo) e em GET /dealer/{dealer_id}/portal.

dica

A listagem GET /dealer/{dealer_id}/portal-auth/ e mais exemplos de uso estão em Autenticação do Portal.

Endpoint

POST /dealer/{dealer_id}/portal-auth/{portal_id}/
PATCH /dealer/{dealer_id}/portal-auth/{portal_id}/

Parâmetro	Descrição
dealer_id	ID da loja (lojaid).
portal_id	ID do site de integração (portal) no sistema.

Pré-requisito

O portal precisa estar liberado e ativo para a loja (LojaIntegradorsite com vínculo ativo e portal ativo no catálogo). Se não estiver, a resposta é 404 Not Found com corpo semelhante a:

{
  "status": false,
  "message": "Portal não está liberado para a loja."
}

POST — envio completo (criar/atualizar integração ativa ou inativar)

No POST, o campo active é obrigatório (true ou false).

Campo (JSON)	Tipo	Obrigatório	Descrição
active	boolean	Sim (POST)	true grava credenciais e mantém integração ativa; false inativa a integração no portal para essa loja.
user	string	Não	Usuário no portal.
password	string	Não	Senha no portal.
site_id	string	Não	Identificador de site/conta no portal, quando aplicável.
token	string	Não	Token exigido pelo portal.
access_token	string	Não	Access token (ex.: OAuth).
refresh_token	string	Não	Refresh token, quando aplicável.
url_inventory	string (URL)	Não	URL de estoque, quando o portal exige.
remove_all	boolean	Não	Com active: false, indica se deve remover todos os anúncios daquele portal (true) ou não (false).

Comportamento resumido:

• active: true: os campos informados são enviados ao serviço de autenticação do integrador (salvar_unitario) e passam a valer para aquela loja e portal.
• active: false: a integração é inativada (inativar_integracao); opcionalmente use remove_all conforme a necessidade operacional.

Resposta de sucesso: 200 OK

{
  "status": true
}

PATCH — atualização parcial

No PATCH, todos os campos do corpo são opcionais. O servidor mescla com os dados já salvos em LojaIntegradorsiteAcesso (se existirem); se ainda não houver registro, parte de valores vazios/ativo conforme o código.

Os mesmos nomes de campo do POST se aplicam (user, password, site_id, token, access_token, refresh_token, url_inventory, active, remove_all).

• Se após o merge o valor efetivo de active for false, a integração é inativada (mesmo fluxo que no POST com active: false).
• Se active for true, as credenciais mescladas são gravadas com salvar_unitario.

Resposta de sucesso: 200 OK com {"status": true}.

Métodos não suportados

GET, PUT e DELETE não são permitidos nesta URL (405 Method Not Allowed).

Exemplo — gravar credenciais (POST)

{
  "active": true,
  "user": "minha_loja_portal",
  "password": "senha-segura",
  "token": "",
  "access_token": "",
  "site_id": "",
  "url_inventory": "https://exemplo.com.br/estoque"
}

Ajuste os campos conforme o portal: muitos só exigem usuário e senha; outros, token ou OAuth (access_token / refresh_token).

Importante

aviso

Cada portal tem suas particularidades e requisitos específicos de autenticação. Para entender os detalhes exatos do processo de autenticação de um portal específico, recomendamos consultar o suporte técnico da Loja Conectada.

O suporte técnico poderá fornecer:

• O método de autenticação utilizado pelo portal
• As credenciais necessárias (usuário/senha, token, ou informações para OAuth)
• Instruções passo a passo específicas para cada portal
• Suporte durante o processo de configuração

Próximos Passos

Após realizar a autenticação e liberação do portal para sua loja:

1. Consulte os portais liberados através do endpoint GET /dealer/{dealer_id}/portal
2. Registre ou atualize as credenciais na plataforma com POST ou PATCH em /dealer/{dealer_id}/portal-auth/{portal_id}/ (seção acima)
3. Verifique os planos disponíveis e a categoria habilitada
4. Siga o guia Por Onde Começar para enviar integrações