Introdução

Bem-vindo à API principal da Uappi Plataforma. Esta aplicação fornece acesso programático completo no padrão REST para gerenciar sua loja e-commerce, incluindo produtos, categorias, pedidos, clientes, pagamentos e muito mais.

Base URL

1https://sua-loja-uappi.com.br/api/v3/

Todos os endpoints da API devem ser acessados através desta URL base da loja.

Versão Atual

Esta versão introduz melhorias significativas em:

• Performance e velocidade de resposta
• Estrutura de dados consistente
• Solução de problemas precisa
• Tipagem e consolidação de dados aprimorada
• Novos recursos de segmentação e personalização
• Suporte expandido para múltiplas políticas comerciais

Formato de Resposta

Todas as respostas da API são retornadas em formato JSON.

🟢 Estrutura padrão de Sucesso

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

O campo "status" com o valor "true" indica que a solicitação foi processada com sucesso, já o campo "data" é reservado a dados que o recurso solicitado pode retornar.

🔴 Estrutura padrão de Erro

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_STORE_PRODUCT_NOT_FOUND",
6    "message": "The requested product was not found."
7  }
8}

Tipos de Recursos

A API está organizada em diferentes categorias:

📰 Recursos Públicos

Recursos acessíveis sem autenticação ou com autenticação pública, como por exemplo:
• Listagem de produtos
• Detalhes de categorias
• Cotação de fretes
• Autenticação de clientes

🔏 Recursos para clientes autenticados

Recursos que requerem autenticação de um cliente da loja:
• Listagem de pedidos
• Edição de senha
• Edição de endereço
• Cadastro de avaliações de produto
• Cadastro de avaliações da loja

🔐 Recursos Administrativos

Recursos que requerem autenticação de usuário administrativo da loja, como por exemplo:
• Gerenciamento de produtos, preços, estoques
• Configurações da loja
• Relatórios
• Gerenciamento de pedidos
• Gerenciamento de clientes

Próximos Passos

• 1. Leia sobre Como Autenticar para começar a fazer requisições
• 2. Entenda os Limites de Rate para otimizar suas integrações
• 3. Familiarize-se com os Códigos de Erro para melhor tratamento de exceções