Para programadores

A API do loyal para caixas, lojas online e sistemas próprios

Uma API REST com chave de API: a caixa credita carimbos e pontos, a loja online comunica as encomendas e o seu sistema regista clientes e resgata cartões. Todos os endpoints estão descritos na documentação.

Abrir a documentação da APIChaves de API no portal

Documentação em inglês, de acesso livre sem iniciar sessão

Exemplo da documentação: pontos por faturação na caixa (loyal COMMERCE)
POST /transaction/revenue
Host: api.loyal-app.de
X-API-Key: your-api-key-here
Content-Type: application/json

{ "userId": "1234567890123",
  "totalCents": 2490 }

→ 24 pontos com 1 ponto por euro

O que se liga através da API

loyal COMMERCE: pontos da loja online e da loja física

A loja online comunica as encomendas pagas; cada número de encomenda é creditado uma única vez e as anulações retiram os pontos. Os pontos transformam-se em códigos de vale que a loja verifica e invalida. Com o loyal COMMERCE no modo de faturação, a caixa credita a faturação da loja física na mesma conta de pontos.

  • POST /shop/orders
  • POST /shop/orders/{orderId}/cancel
  • POST /shop/redeem
  • POST /transaction/revenue
Secção loyal COMMERCE na documentação

Ligação à caixa: creditar e resgatar carimbos

A caixa credita carimbos, consulta o saldo de um cartão e resgata cartões completos. Os novos clientes são registados com o endereço de e-⁠mail; a resposta contém o ID de cliente para todas as chamadas seguintes.

  • POST /user
  • POST /transaction
  • GET /user
  • POST /redeem
Primeiros passos com a caixa na documentação

Chaves de API geridas de forma autónoma

As chaves são criadas no portal, de forma autónoma, com a função POS (caixa) ou ADMIN. A chave completa só é mostrada uma vez e depois fica mascarada. Para a trocar, cria-se uma nova e desativa-se a antiga. Cada pedido envia-a no cabeçalho X-API-Key.

  • X-API-Key
Autenticação na documentação

Ligar a caixa em quatro passos

  1. Criar no portal uma chave de API com a função POS.
  2. Registar clientes: POST /user com o endereço de e-⁠mail.
  3. Creditar carimbos: POST /transaction.
  4. Resgatar cartões completos: POST /redeem.
Abrir a documentação da APIChaves de API no portal