[API] Guia de uso da API aberta + serviço MCP

O UpSeller agora oferece suporte a API aberta e MCP (conexão com ferramentas de IA). Você pode integrar perfeitamente as capacidades de dados do UpSeller ao seu próprio sistema ou conectá-las a ferramentas de IA como Claude, Codex, ChatGPT, Cursor, entre outras, para uma gestão inteligente de e-commerce.

Disponibilidade

O recurso está disponível para usuários dos planos Profissional e superiores e do Plano Kit, sem custo adicional.

I. Recursos disponíveis

Atualmente, o MCP do UpSeller oferece os seguintes recursos:


	

	
Consultar a lista de armazéns: permite consultar todos os armazéns disponíveis na conta atual.
	
	

	
Consultar detalhes de estoque de SKU: permite consultar os detalhes de estoque de todos os SKUs ou de SKUs específicos em um determinado armazém.
	


II. Limites de solicitações

Aviso: os limites de solicitação são definidos por interface.



III. Recursos disponíveis

IV. Como obter as informações de autenticação

Antes de iniciar a configuração, acesse o painel do UpSeller para obter suas credenciais exclusivas (User ID, API Token e MCP Token).

Passo 1: Ativar o recurso

1. Acesse o painel do UpSeller e, no menu lateral esquerdo, clique em Plataforma Aberta → API Privada.

2. No primeiro uso, clique no botão azul Gerar na área principal à direita.



Passo 2: Copiar as credenciais de autenticação

Após a geração, o sistema exibirá as seguintes informações de autenticação. Guarde-as com segurança:


	
ID do Cliente: código exclusivo de identificação da sua conta.
	
Token de API: chave de autenticação usada para chamadas de API tradicionais.
	
Token MCP: chave de autenticação usada para conectar modelos de IA ou ferramentas de desenvolvimento de IA.




Aviso: Os Tokens são informações sensíveis. Não compartilhe seus Tokens com terceiros. Caso identifique algum risco de segurança, você pode redefinir ou excluir o Token a qualquer momento nesta mesma página.

V. Como conectar a API e o MCP

1. Documentação da API de consulta de estoque

Visão geral

Esta API oferece recursos de gerenciamento de armazéns e consulta de estoque, permitindo consultar a lista de armazéns da conta atual e a lista de estoque dos armazéns com paginação.

Informações básicas


	

	
Protocolo: HTTP/HTTPS
	
	

	
Método da solicitação: POST
	
	

	
Formato dos dados: JSON
	
	

	
Método de autenticação: autenticação por Token de API (transmitido pelo cabeçalho da solicitação)
	


Cabeçalhos de solicitação padrão

Formato de resposta padrão




Descrição dos campos de resposta padrão

Códigos de erro padrão

Detalhes da API

1. Consultar a lista de armazéns

Descrição da API

Consultar a lista de armazéns da conta atual.



Informações da solicitação


	

	
URL: https://openapi.upseller.com/erp/inventory/getWarehouseList/v1
	
	

	
Método: POST
	
	

	
Tipo de conteúdo: application/json
	


Cabeçalhos da solicitação

Consulte os Cabeçalhos de solicitação padrão.



Corpo da solicitação





Descrição dos campos do corpo da solicitação





Exemplo de solicitação





Descrição dos campos dos dados de resposta





Exemplo de resposta



 

2. Consultar a lista de estoque dos armazéns com paginação

Descrição da API

Consultar a lista de estoque dos armazéns com paginação.



Informações da solicitação


	

	
URL:https://openapi.upseller.com/erp/inventory/pageWarehouseSku/v1
	
	

	
Método: POST
	
	

	
Tipo de conteúdo: application/json
	


Cabeçalhos da solicitação

Consulte os Cabeçalhos de solicitação padrão.



Corpo da solicitação





Exemplo de solicitação





Descrição dos campos do corpo da solicitação





Descrição dos campos dos dados de resposta





Exemplo de resposta



 

Tratamento de erros comuns

1. Falha na autenticação: verifique se os cabeçalhos da solicitação estão configurados corretamente.

2. Erro de parâmetros: confirme o formato dos parâmetros da solicitação e os campos obrigatórios.

3. Erro do servidor: entre em contato com o suporte técnico e forneça o requestID para rastreamento do problema.

Observações

1. Todos os campos de data utilizam o formato ISO 8601 (por exemplo: 2023-01-01T12:00:00Z).

2. Recomenda-se implementar um mecanismo adequado de nova tentativa (retry) para as solicitações, especialmente em situações de instabilidade de rede.

3. Para consultas paginadas, configure corretamente PageNo e PageSize para evitar problemas de desempenho.