API de Integração - FidelizeApp

🚀 Comece Agora

Sua Base URL para integrações

https://app.fidelizeapp.com.br/api/integration

📋 Visão Geral

A API do FidelizeApp permite que você integre seu ERP ou sistema externo com nosso sistema de fidelidade, enviando pontos automaticamente para seus clientes baseado em suas vendas.

⚡

Rápido

Respostas em menos de 200ms

🔒

Seguro

Autenticação via Bearer Token

📚

Simples

Documentação completa e exemplos

Base URL da API

Use esta URL como base para todas as suas requisições

https://app.fidelizeapp.com.br/api/integration

ℹ️

Configuração de Limites

A quantidade máxima de pontos por envio é configurável nos Parâmetros do Sistema. Acesse Configurações > Parâmetros para ajustar o limite conforme sua necessidade.

🔐 Autenticação

Nossa API usa autenticação via Bearer Token. Você precisa gerar um token de API nas configurações da sua conta.

Como obter o token:

Faça login na sua conta do FidelizeApp
Acesse Configurações no menu superior
Na seção "Token de API para Integrações", clique em "Criar Token de Integração"
Copie o token exibido (ele só aparece uma vez!)
Salve o token em local seguro

Como usar o token:

Inclua o token no header Authorization de todas as requisições:

Authorization: Bearer SEU_TOKEN_AQUI

🚀 Endpoints

🔗

Base URL:

https://app.fidelizeapp.com.br/api/integration

POST


                                    /points

Endpoint completo:


                                https://app.fidelizeapp.com.br/api/integration/points

Envia pontos de fidelidade para um cliente específico.

Parâmetros:

Campo	Tipo	Obrigatório	Descrição
phone	string	✅ Sim	Número de telefone do cliente
points	integer	❌ Não	Quantidade de pontos (padrão: 1, máximo configurável nos parâmetros do sistema)

Exemplo de Requisição:

{
  "phone": "11999999999",
  "points": 3
}

Resposta de Sucesso (200):

{
  "success": true,
  "message": "Pontos enviados com sucesso para 11999999999"
}

Resposta de Erro (400):

{
  "success": false,
  "message": "Conta não possui assinatura ativa"
}

⚖️ Validações e Limites

Limites de Pontos

O sistema possui validações automáticas para garantir a integridade dos dados e limites de negócio:

📊

Limite Máximo de Pontos

Configurável nos Parâmetros do Sistema (Configurações > Parâmetros). O valor padrão é definido pelo parâmetro qtd-points-send.

🔒

Limite de Segurança

Máximo de 10 pontos por requisição (limite hardcoded de segurança).

📱

Validação de Telefone

Número deve conter apenas dígitos e ter formato válido (mínimo 10 dígitos).

💳

Limite de Cartões Ativos

Respeitado o limite do plano de assinatura da conta.

Importante

Todas as validações retornam erro 400 (Bad Request) com mensagem descritiva quando não atendidas.

💻 Exemplos de Integração

🐘 PHP (cURL)

Erro na resposta da API

🟨 JavaScript (Fetch)

const token = 'SEU_TOKEN_AQUI';
const baseUrl = "https://app.fidelizeapp.com.br/api/integration";

// Adicionar pontos
async function addPoints(phone, points = 1) {
    const response = await fetch(`${baseUrl}/points`, {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'Authorization': `Bearer ${token}`
        },
        body: JSON.stringify({
            phone: phone,
            points: points
        })
    });

    const data = await response.json();
    if (data && data.message) {
        console.log(data.message);
    } else {
        console.log('Erro na resposta da API');
    }
}

// Exemplo de uso
addPoints('11999999999', 3); // Envia 3 pontos
addPoints('11999999999');    // Envia 1 ponto (padrão)

🐍 Python (Requests)

import requests

token = 'SEU_TOKEN_AQUI'
base_url = "https://app.fidelizeapp.com.br/api/integration"

# Adicionar pontos
def add_points(phone, points=1):
    url = f"{base_url}/points"
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {token}'
    }
    data = {
        'phone': phone,
        'points': points
    }

    response = requests.post(url, json=data, headers=headers)
    result = response.json()
    if result and 'message' in result:
        print(result['message'])
    else:
        print('Erro na resposta da API')

# Exemplo de uso
add_points('11999999999', 3)  # Envia 3 pontos
add_points('11999999999')     # Envia 1 ponto (padrão)

💻 cURL

curl -X POST https://app.fidelizeapp.com.br/api/integration/points \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "phone": "11999999999",
    "points": 3
  }'

❌ Códigos de Erro

Código	Descrição	Possíveis Causas
400	Bad Request	Dados inválidos, conta sem assinatura, limite de cartões atingido, pontos excedem limite configurado
401	Unauthorized	Token inválido, expirado ou ausente
422	Unprocessable Entity	Dados de validação incorretos (telefone inválido, pontos inválidos)
500	Internal Server Error	Erro interno do servidor

✨ Funcionalidades

🤖

Automação Completa

Cria usuários e cartões automaticamente quando necessário

📱

Notificações

Envia SMS e push notifications automaticamente

🔒

Segurança

Validações completas e logs de auditoria

⚡

Performance

Processamento assíncrono e respostas rápidas

📊

Relatórios

Acompanhe o uso da API nas configurações

🔄

Consistência

Mesma lógica do dashboard, garantindo consistência

🆘 Suporte

💬

Precisa de ajuda?

Nossa equipe está pronta para ajudar você a integrar sua API.

📧 Enviar Email 🎫 Central de Suporte