QR codes

Crie QR codes com logo, cores, estilos e tipos de conteúdo, depois liste ou atualize.

Tipos suportados

Passe type como uma destas chaves. Os campos de conteúdo mudam com o tipo.

text
url
phone
sms
email
whatsapp
facetime
location
wifi
event
vcard
crypto
paypal
upi
epc
pix

POST/api/v1/qr-codes

Criar QR code

Envie JSON no corpo da requisição. name e type são obrigatórios. Para tipos url, envie url. Adicione style, cores e qr_code_logo para reproduzir um código do estúdio. O tipo file não está disponível na API.

Nome	Tipo	Obrigatório	Padrão	Descrição
name	string	Sim	—	Rótulo salvo no recurso.
type	string	Sim	url	Tipo de conteúdo. Uma das chaves QR suportadas, exceto file.
url	string	Não	—	URL de destino. Obrigatório quando type é url.
text	string	Não	—	Texto simples. Obrigatório quando type é text. Para texto em massa, separe as linhas neste campo.
url_dynamic	boolean	Não	false	Se true, um link curto é criado e o QR codifica esse link para o destino poder mudar depois.
project_id	integer	Não	—	Projeto ao qual anexar o recurso.
is_bulk	boolean	Não	false	Se true e type for text, um QR é criado por linha em text.
style	string	Não	square	Forma do módulo. Exemplos: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Não	square	Forma do padrão de busca interno. Exemplos: square, dot, circle, rounded.
outer_eye_style	string	Não	square	Forma do padrão de busca externo. Exemplos: square, circle, rounded, flower.
size	integer	Não	500	Tamanho da imagem em pixels, 50–2000.
margin	integer	Não	0	Módulos da zona de silêncio, 0–25.
ecc	string	Não	M	Correção de erros: L, M, Q ou H. Use H ao adicionar um logo.
foreground_type	string	Não	color	color ou gradient.
foreground_color	string	Não	#000000	Cor dos módulos em HEX.
foreground_gradient_style	string	Não	horizontal	vertical, horizontal, diagonal, inverse_diagonal ou radial.
foreground_gradient_one	string	Não	—	Primeira cor HEX do degradê.
foreground_gradient_two	string	Não	—	Segunda cor HEX do degradê.
background_color	string	Não	#ffffff	Cor HEX do fundo. Mantenha mais clara que os módulos.
background_color_transparency	integer	Não	0	Transparência do fundo, 0–100.
custom_eyes_color	boolean	Não	false	Se true, os olhos usam eyes_inner_color e eyes_outer_color.
eyes_inner_color	string	Não	#000000	Cor HEX do olho interno.
eyes_outer_color	string	Não	#000000	Cor HEX do olho externo.
qr_code_logo	string	Não	—	URL da imagem do logo ou chave do arquivo enviado.
qr_code_logo_size	number	Não	25	Tamanho do logo como porcentagem do QR, 5–40.
frame	string	Não	—	Chave de moldura opcional do estúdio.
frame_text	string	Não	—	Legenda desenhada na moldura.

Campos de conteúdo por tipo

Nome	Tipo	Obrigatório	Padrão	Descrição
phone	string	Não	—	Número de telefone quando type é phone.
sms	string	Não	—	Número de telefone quando type é sms.
sms_body	string	Não	—	Corpo da mensagem SMS.
email	string	Não	—	Destinatário quando type é email.
email_subject	string	Não	—	Assunto do e-mail.
email_body	string	Não	—	Corpo do e-mail.
whatsapp	string	Não	—	Número do WhatsApp, só dígitos.
whatsapp_body	string	Não	—	Texto do WhatsApp pré-preenchido.
wifi_ssid	string	Não	—	Nome da rede quando type é wifi.
wifi_password	string	Não	—	Senha Wi-Fi.
wifi_encryption	string	Não	WPA	nopass, WEP, WPA ou WPA/WPA2.
location_latitude	number	Não	—	Latitude quando type é location.
location_longitude	number	Não	—	Longitude quando type é location.
event	string	Não	—	Título do evento quando type é event.
event_start_datetime	string	Não	—	Data e hora ISO do início do evento.
vcard first_name / last_name / email	string	Não	—	Campos vCard: first_name, last_name, email e as demais chaves do estúdio.

Exemplo de requisição

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Website QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "rounded",
  "size": 500,
  "ecc": "M",
  "foreground_color": "#17191c",
  "background_color": "#ffffff",
  "qr_code_logo": "https://forqrcode.com/logo.png",
  "qr_code_logo_size": 25
}'

Mais exemplos

QR com degradê

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Gradient QR",
  "type": "url",
  "url": "https://forqrcode.com",
  "style": "dot",
  "inner_eye_style": "circle",
  "outer_eye_style": "rounded",
  "foreground_type": "gradient",
  "foreground_gradient_style": "radial",
  "foreground_gradient_one": "#5c8b29",
  "foreground_gradient_two": "#25492f",
  "background_color": "#ffffff",
  "size": 600
}'

QR Wi-Fi

curl -X POST 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Office Wi-Fi",
  "type": "wifi",
  "wifi_ssid": "Guest",
  "wifi_password": "correct-horse",
  "wifi_encryption": "WPA",
  "style": "square",
  "ecc": "H"
}'

Exemplo de resposta

{
  "data": {
    "id": 1,
    "type": "url",
    "name": "Website QR",
    "qr_code": "https://…/qr-codes/…/qr.svg",
    "settings": {
      "style": "rounded",
      "size": 500,
      "ecc": "M"
    }
  }
}

GET/api/v1/qr-codes

Listar QR code

Nome	Tipo	Obrigatório	Descrição
page	integer	Não	Page number (default 1)
results_per_page	integer	Não	Items per page (default 25, max 100)
search	string	Não	Search term
search_by	string	Não	Column to search
order_by	string	Não	Sort column
order_type	string	Não	asc or desc
datetime_start	string	Não	ISO datetime filter start
datetime_end	string	Não	ISO datetime filter end
project_id	integer	Não	—
type	string	Não	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes' \
  -H 'Authorization: Bearer YOUR_API_KEY'

GET/api/v1/qr-codes/{id}

Ler um QR code

Nome	Tipo	Obrigatório	Descrição
id	integer	Sim	—

curl -X GET 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

PATCH/api/v1/qr-codes/{id}

Atualizar QR code

Nome	Tipo	Obrigatório	Padrão	Descrição
id	integer	Sim	—	—
name	string	Não	—	Rótulo salvo no recurso.
type	string	Não	url	Tipo de conteúdo. Uma das chaves QR suportadas, exceto file.
url	string	Não	—	URL de destino. Obrigatório quando type é url.
text	string	Não	—	Texto simples. Obrigatório quando type é text. Para texto em massa, separe as linhas neste campo.
url_dynamic	boolean	Não	false	Se true, um link curto é criado e o QR codifica esse link para o destino poder mudar depois.
project_id	integer	Não	—	Projeto ao qual anexar o recurso.
is_bulk	boolean	Não	false	Se true e type for text, um QR é criado por linha em text.
style	string	Não	square	Forma do módulo. Exemplos: square, dot, rounded, heart, hexagon.
inner_eye_style	string	Não	square	Forma do padrão de busca interno. Exemplos: square, dot, circle, rounded.
outer_eye_style	string	Não	square	Forma do padrão de busca externo. Exemplos: square, circle, rounded, flower.
size	integer	Não	500	Tamanho da imagem em pixels, 50–2000.
margin	integer	Não	0	Módulos da zona de silêncio, 0–25.
ecc	string	Não	M	Correção de erros: L, M, Q ou H. Use H ao adicionar um logo.
foreground_type	string	Não	color	color ou gradient.
foreground_color	string	Não	#000000	Cor dos módulos em HEX.
foreground_gradient_style	string	Não	horizontal	vertical, horizontal, diagonal, inverse_diagonal ou radial.
foreground_gradient_one	string	Não	—	Primeira cor HEX do degradê.
foreground_gradient_two	string	Não	—	Segunda cor HEX do degradê.
background_color	string	Não	#ffffff	Cor HEX do fundo. Mantenha mais clara que os módulos.
background_color_transparency	integer	Não	0	Transparência do fundo, 0–100.
custom_eyes_color	boolean	Não	false	Se true, os olhos usam eyes_inner_color e eyes_outer_color.
eyes_inner_color	string	Não	#000000	Cor HEX do olho interno.
eyes_outer_color	string	Não	#000000	Cor HEX do olho externo.
qr_code_logo	string	Não	—	URL da imagem do logo ou chave do arquivo enviado.
qr_code_logo_size	number	Não	25	Tamanho do logo como porcentagem do QR, 5–40.
frame	string	Não	—	Chave de moldura opcional do estúdio.
frame_text	string	Não	—	Legenda desenhada na moldura.

Exemplo de requisição

curl -X PATCH 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://forqrcode.com/pricing",
  "foreground_color": "#5d2a1a"
}'

DELETE/api/v1/qr-codes/{id}

Excluir QR code

Nome	Tipo	Obrigatório	Descrição
id	integer	Sim	—

curl -X DELETE 'https://forqrcode.com/api/v1/qr-codes/{id}' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parâmetros e exemplos JSON aparecem em inglês. Substitua YOUR_API_KEY pela sua chave.