Endpoints

Endpoints

A resposta de sucesso dos dois é a imagem crua (Content-Type: image/png), não o envelope JSON que o resto da API usa. É um PNG, não dado estruturado. Erros continuam vindo como JSON normalmente.

The success response for both is the raw image (Content-Type: image/png), not the JSON envelope the rest of the API uses. It's a PNG, not structured data. Errors still come back as JSON as usual.

Parâmetros

Parameters

Exemplo

Example

curl "https://api.alicercelabs.com.br/api/v1/qrcode?data=https://alicercelabs.com.br&size=256" \
          -H "Authorization: Bearer <token>" \
          -o qrcode.png

O arquivo salvo é um PNG de verdade, pronto pra abrir ou embutir num <img src>. Não tem passo de decodificação, o corpo da resposta já é a imagem.

The saved file is a real PNG, ready to open or embed in an <img src>. No decoding step, the response body already is the image.

Erros possíveis

Possible errors

QR code de Pix

Pix QR code

Monta o payload EMV/BR Code do Pix (o mesmo formato do "copia e cola") a partir de chave, nome e cidade do recebedor, e devolve tanto a imagem quanto o texto: o PNG no corpo da resposta, o payload no header X-Pix-Copia-Cola. É um QR estático, reutilizável, não expira nem depende de um servidor pra confirmar o pagamento depois.

Builds the Pix EMV/BR Code payload (the same format behind the "copy and paste" code) from the recipient's key, name and city, and returns both: the PNG in the response body, the payload in the X-Pix-Copia-Cola header. It's a static, reusable QR code, it doesn't expire or depend on a server to confirm payment afterward.

curl "https://api.alicercelabs.com.br/api/v1/qrcode/pix?chave=11999999999&nome=Fulano&cidade=Sao+Paulo&valor=10.50" \
          -H "Authorization: Bearer <token>" \
          -o pix.png -D headers.txt
grep Pix-Copia-Cola headers.txt

Não valida se a chave existe de verdade, só o formato: confirmar isso exigiria consultar o DICT do Banco Central, fora do escopo desta API. Uma chave inválida gera um QR code válido que o app do pagador vai rejeitar na hora de pagar.

Doesn't validate whether the key actually exists, only its format: confirming that would require querying the Central Bank's DICT, out of scope for this API. An invalid key produces a valid QR code that the payer's app will reject at payment time.

Usando o SDK

Using the SDK

As duas rotas devolvem um PNG cru, não o envelope JSON. .Save(caminho) grava o arquivo direto.

Both routes return a raw PNG, not the JSON envelope. .Save(path) writes the file directly.

SDKs oficiais: Go · Python · JavaScript.

Official SDKs: Go · Python · JavaScript.

Gerar um QR code

Generate a QR code

import (
	"context"
	"fmt"

	alicercelabs "github.com/alicercelabs/alicercesdk-go"
)

client := alicercelabs.New("alk_...")
ctx := context.Background()

qr, err := client.QRCode.Generate(ctx, "https://alicercelabs.com.br", 512)
if err != nil {
	panic(err)
}
qr.Save("qrcode.png")

from alicercelabs import AlicerceLabs

client = AlicerceLabs(api_key="alk_...")

qr = client.qrcode.generate("https://alicercelabs.com.br", size=512)
qr.save("qrcode.png")

import { AlicerceLabs } from "alicercesdk-javascript";

const client = new AlicerceLabs("alk_...");

const qr = await client.qrcode.generate("https://alicercelabs.com.br", 512);
await qr.save("qrcode.png");

QR code de Pix

Pix QR code

monta o payload EMV/BR Code e devolve o PNG; o "copia e cola" vem no header X-Pix-Copia-Cola.

builds the EMV/BR Code payload and returns the PNG; the "copia e cola" text comes in the X-Pix-Copia-Cola header.

pix, err := client.QRCode.Pix(ctx, alicercelabs.PixParams{
	Chave:  "11999999999",
	Nome:   "Fulano de Tal",
	Cidade: "Sao Paulo",
	Valor:  10.50, // opcional, sem isso quem paga digita o valor
})
pix.Save("pix.png")
fmt.Println(pix.CopiaCola)

pix = client.qrcode.pix(chave="11999999999", nome="Fulano de Tal", cidade="Sao Paulo", valor=10.50)
pix.save("pix.png")
print(pix.headers["x-pix-copia-cola"])

const pix = await client.qrcode.pix({
  chave: "11999999999",
  nome: "Fulano de Tal",
  cidade: "Sao Paulo",
  valor: 10.50, // opcional, sem isso quem paga digita o valor
});
await pix.save("pix.png");
console.log(pix.headers.get("X-Pix-Copia-Cola"));

Limites

Limits

100/dia · 4/hora sem token, por IP chamador; com uma API key (gerada no painel), 1.000/dia · 41/hora. Contado separado por operação: /qrcode e /qrcode/pix têm cotas independentes. Os dois endpoints geram o mesmo conteúdo pra os mesmos parâmetros, então o resultado fica em cache por 24h. Chamadas repetidas com os mesmos parâmetros não recalculam nada.

100/day · 4/hour without a token, per calling IP; with an API key (generated in the panel), 1,000/day · 41/hour. Counted separately per operation: /qrcode and /qrcode/pix have independent quotas. Both endpoints produce the same content for the same parameters, so the result is cached for 24h. Repeated calls with the same parameters don't recompute anything.