Documentação da API

API REST apenas de leitura. Disponível no plano Pro.

Como obter a sua chave de API

Se estiver no plano Pro, aceda a Painel → Definições → Acesso à API e clique em Gerar Chave de API. Mantenha esta chave em segredo — qualquer pessoa que a tenha pode ler os dados de fidelidade do seu negócio.

Autenticação

Cada pedido tem de incluir a sua api_key como parâmetro de consulta ou campo do formulário. Pedidos sem uma chave válida para um negócio com plano Pro devolvem:

{
  "response": {
    "error": "invalid_or_unauthorized_api_key"
  }
}

URL base

https://app.loyaltyloop.co/api/1.1/wf

Endpoints

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_summary

Estatísticas agregadas do seu negócio: número de cartões, clientes, carimbos e recompensas, além da taxa de resgate.

Parâmetros

api_key (obrigatório) — A sua chave de API.

Exemplo de resposta

{
  "response": {
    "cards_count": 42,
    "customers_count": 318,
    "stamps_count": 1204,
    "rewards_count": 87,
    "redemption_rate": 63
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_cards

Lista todos os cartões de fidelidade do seu negócio.

Parâmetros

api_key (obrigatório) — A sua chave de API.

Exemplo de resposta

{
  "response": {
    "cards": [
      { "_id": "...", "name": "Coffee Card", "stamps_required": 10 }
    ]
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_customers

Lista todos os clientes que aderiram a um cartão de fidelidade no seu negócio.

Parâmetros

api_key (obrigatório) — A sua chave de API.

Exemplo de resposta

{
  "response": {
    "customers": [
      { "_id": "...", "name": "Jane Doe", "phone": "+351..." }
    ]
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_stamps

Lista os carimbos recolhidos no seu negócio, opcionalmente filtrados por intervalo de datas.

Parâmetros

api_key (obrigatório) — A sua chave de API.
start_date (opcional) — Data em formato ISO. Omita para incluir todo o histórico.
end_date (opcional) — Data em formato ISO. Omita para incluir até ao momento atual.

Exemplo de resposta

{
  "response": {
    "stamps": [
      { "_id": "...", "Created Date": "2026-07-01T12:00:00Z" }
    ]
  }
}

GEThttps://app.loyaltyloop.co/api/1.1/wf/api_v1_rewards

Lista as recompensas emitidas no seu negócio, opcionalmente filtradas por estado.

Parâmetros

api_key (obrigatório) — A sua chave de API.
status (opcional) — p. ex. "redeemed". Omita para incluir todos os estados.

Exemplo de resposta

{
  "response": {
    "rewards": [
      { "_id": "...", "status": "redeemed" }
    ]
  }
}

Questões

Envie um email para hello@loyaltyloop.co se tiver problemas a integrar com a API.