Documentação API - Gestão de Compradores (Shoppers)

Esta documentação detalha os endpoints disponíveis para gerenciamento de compradores na plataforma.

Base URL

• Produção: https://nuzap.com.br/api
• Desenvolvimento: http://localhost/meusprodutosonline/api

Autenticação

Todas as requisições necessitam do token de autenticação no header:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

1. Criar Comprador

Registra um novo comprador no sistema.

POST /shopper

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "João Silva",
    "email": "[email protected]",
    "phone": "31999999999"
}

2. Buscar Comprador

Retorna informações de um comprador específico.

GET /shopper/{shopper_id}?_store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

3. Listar Compradores

Lista todos os compradores com opção de filtro por nome.

GET /shopper?_store={store}&_name={name}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

4. Atualizar Comprador

Atualiza informações de um comprador existente.

PUT /shopper/{shopper_id}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Body Parameters

Exemplo de Requisição

{
    "store": "zatinni",
    "name": "João Silva Update",
    "phone": "31999999999",
    "active": true,
    "instagram": "joaosilva",
    "link": "https://meusite.com"
}

5. Deletar Comprador

Remove um comprador do sistema.

DELETE /shopper/{shopper_id}?_store={store}

Headers

• Content-Type: application/json
• Authorization: Bearer {token}

Query Parameters

Códigos de Status

Validações

• Email deve ser único por loja
• Telefone deve estar em formato válido
• Nome deve ter no mínimo 3 caracteres
• Links devem ser URLs válidas
• Perfil do Instagram deve conter apenas caracteres válidos

Limites

• Tamanho máximo do nome: 100 caracteres
• Tamanho máximo do email: 100 caracteres
• Tamanho máximo do telefone: 20 caracteres
• Tamanho máximo do Instagram: 30 caracteres
• Tamanho máximo do link: 255 caracteres
• Não exceder os limites do seu token da API

Boas Práticas

1. Sempre valide o email antes de criar um comprador
2. Mantenha o formato do telefone consistente
3. Use o campo active para desativar compradores ao invés de deletá-los
4. Armazene URLs completas no campo link

Suporte

Para suporte técnico ou dúvidas:

• Email: [email protected]
• Documentação completa: https://docs.nuzap.com.br

Observações

• Todos os timestamps são retornados em UTC
• URLs são automaticamente normalizadas antes do armazenamento