← Voltar ao blog
IA e automatização2 min de leitura

CLI com --json: aproveitar as saídas do Same-QR em scripts

Imagem do Unsplash

Porque JSON para programas

Os programas de linha de comandos costumam responder a pessoas: uma frase, uma tabela. Um script teria de cortar esse texto aos bocados e esperar que o formato nunca mude. O JSON é um formato de texto para dados estruturados que praticamente qualquer linguagem consegue ler. Uma CLI com saída JSON devolve a mesma informação numa forma fixa.

A opção --json

Todos os comandos da CLI sameqr conhecem --json. Em vez da tabela, recebes a resposta da API em JSON:

sameqr qr list --json
sameqr qr create --name "Plakat Nord" --url https://example.com/aktion --json
sameqr seite list --json

Processar com jq

Em scripts de shell, a pequena ferramenta jq extrai valores individuais. Assim podes listar o nome e os scans de todos os códigos QR ou guardar o identificador de um novo código QR:

sameqr qr list --json | jq -r '.codes[] | "\(.name);\(.scanCount)"'

id=$(sameqr qr create --name "Plakat Süd" --url https://example.com/aktion --json | jq -r .id)
sameqr qr stats "$id"

Detetar erros no script

Com --json, os erros também chegam em JSON, e na saída de erros, para não se misturarem com os dados propriamente ditos. Além disso, o código de retorno revela o tipo de erro:

  • 0: tudo em ordem.
  • 2: entrada errada ou em falta, por exemplo um --name esquecido.
  • 3: sem sessão iniciada ou chave inválida.
  • 4: sem permissão, por exemplo uma chave “só leitura” ou um limite do plano.
  • 1: outro erro da API.

Interrompe os ciclos no primeiro erro, em vez de produzires cem vezes o mesmo erro, por exemplo com “|| break” a seguir ao comando.

Exemplos de fluxos

  • Uma lista de locais transforma-se em códigos QR e as respostas JSON ficam num ficheiro para a gráfica.
  • Uma tarefa mensal guarda “sameqr qr list --json” como ponto de situação para o relatório de scans.
  • Um agente de programação chama a própria CLI e lê as respostas JSON para planear os passos seguintes.

Conclusão: porquê o Same-QR

A CLI sameqr foi feita para scripts: JSON quando quiseres, erros bem separados e com códigos de retorno inequívocos, chave vinda do ambiente e não da linha de comandos. Assim, comandos soltos tornam-se fluxos fiáveis, com o Same-QR em todos os planos.

Começa já: regista-te gratuitamente em sameqr.com, 20 códigos QR dinâmicos são grátis para sempre. API, CLI e servidor MCP existem em todos os planos, a documentação está em sameqr.com/entwickler.

Cria códigos QR dinâmicos grátis
Começa com 20 códigos QR dinâmicos grátis para sempre. Sem subscrição, sem cartão de crédito.
Começar grátis agora →

Perguntas frequentes

Tenho de usar sempre --json?

Não. No terminal, a saída normal é mais agradável. O --json destina-se a scripts e programas.

Onde ficam as mensagens de erro?

Na saída de erros, e com --json também em JSON, com status, code e message. Os dados em si ficam na saída normal.

Como é que o meu script reconhece uma chave em falta?

Pelo código de retorno 3. O código de retorno 4 significa falta de permissão.

Newsletter

Novos artigos diretamente na tua caixa de correio

Dicas sobre códigos QR dinâmicos, novidades, sem spam. Podes cancelar a qualquer momento.

Ao subscreveres, aceitas receber a newsletter. Podes retirar o consentimento a qualquer momento através da ligação de cancelamento incluída em cada e-mail.

Continua a ler