---
title: "POST /qr-codes"
description: "Listar/criar configurações persistidas de QR — parâmetros, schemas e exemplos completos."
sidebar:
  hidden: true
---

**Listar/criar configurações persistidas de QR.** Contrato v1 · disponível em produção e homologação · operação `createQrCodes`. [Guia funcional](/produto/qr/) · [Índice](/api/operacoes/) · [Schemas](/referencia/) · [Testar em sandbox](/console/?operation=createQrCodes).

## Autenticação e efeito

Permissão: `qr_codes:create`. Sessão humana ou chave de servidor limitada ao proprietário e aos aplicativos autorizados. OAuth/MCP ainda não estão disponíveis. Uma chave de exemplo deve incluir somente esta permissão e as leituras necessárias ao seu fluxo, restrita a `app_loja`; emita-a na área autenticada de desenvolvedores.

Disponível em produção e homologação; sujeito às capacidades do app e à configuração do provedor. OAuth só será aceito após B1b. Campos desconhecidos rejeitados. Consulte os ADRs para regras semânticas além do JSON Schema.

O efeito é autenticado, auditado e pode gerar publicação eventual e eventos do recurso. Links/domínios/templates podem precisar de propagação antes de aparecerem publicamente. Não muda identidade de link implicitamente. Dependências e capabilities podem bloquear a ação. O status confirma a persistência descrita, sem prometer propagação global imediata.

## Parâmetros

| Nome | Local | Obrigatório | Tipo e restrições |
| --- | --- | --- | --- |
| `Idempotency-Key` | header | sim | UUID v4 por intenção. Recibo por 24h. Mudança de payload/precondição retorna 409. Segredo de chave não é reexibido. IdempotencyKey; {"type":"string","maxLength":36,"pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"} |



## Corpo e semântica

Content-Type: `application/json`. Campos desconhecidos são rejeitados no envelope.

| Campo | Tipo | Obrigatório | Significado e limites |
| --- | --- | --- | --- |
| `appId` | AppId | sim | Aplicativo proprietário; precisa estar autorizado.  |
| `linkId` | LinkId | sim | Identidade composta do link.  |
| `name` | string | sim | Nome de exibição. Até 100 caracteres; Formato validado pelo schema |
| `style` | QrStyle | não | Valor tipado; formato e restrições completos no schema abaixo.  |
| `style.size` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo. Mínimo 256; Máximo 1024 |
| `style.margin` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo. Mínimo 4; Máximo 16 |
| `style.errorCorrectionLevel` | M / Q / H | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `style.dark` | #000000 / #0f172a | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `style.light` | objeto | sim | Valor tipado; formato e restrições completos no schema abaixo.  |

Omitir campos opcionais usa o default documentado ou preserva o valor em PATCH. `null` só é aceito nos campos cujo schema permite null, com efeito de limpar/desvincular indicado no guia. Arrays enviados substituem a coleção quando o endpoint define atualização completa; não implicam merge. Identificadores/owner/app de um recurso existente não são transferidos por PATCH. Herança de templates/UTMs segue o guia, sem alterar links anteriores por cópia automática.

### Request mínimo

```json
{
  "appId": "app_loja",
  "linkId": "go.example.com~-ofertas~-tenis",
  "name": "Vitrine"
}
```

### Request completo de referência

```json
{
  "appId": "app_loja",
  "linkId": "go.example.com~-ofertas~-tenis",
  "name": "Vitrine",
  "style": {
    "size": 512,
    "margin": 4,
    "errorCorrectionLevel": "M",
    "dark": "#0f172a",
    "light": "#ffffff"
  }
}
```



## cURL

`AGILINK_API_KEY` deve ficar no servidor. Os placeholders abaixo são fictícios. Preserve Idempotency-Key e payload ao repetir uma intenção após timeout.

```sh
curl --request POST 'https://api.staging.agilink.io/v1/qr-codes' \
  --header 'Authorization: Bearer <credencial>' \
  --header 'Idempotency-Key: 10000000-0000-4000-8000-000000000001' \
  --header 'Content-Type: application/json' \
  --data '{"appId":"app_loja","linkId":"go.example.com~-ofertas~-tenis","name":"Vitrine","style":{"size":512,"margin":4,"errorCorrectionLevel":"M","dark":"#0f172a","light":"#ffffff"}}'
```

## JavaScript / TypeScript

```js
// Node.js 22+. Defina AGILINK_API_KEY no ambiente do servidor.
const response = await fetch('https://api.staging.agilink.io/v1/qr-codes', {
  method: 'POST',
  headers: {
  "Authorization": `Bearer ${process.env.AGILINK_API_KEY}`,
  "Idempotency-Key": "10000000-0000-4000-8000-000000000001",
  "Content-Type": "application/json"
},
  body: JSON.stringify({
  "appId": "app_loja",
  "linkId": "go.example.com~-ofertas~-tenis",
  "name": "Vitrine",
  "style": {
    "size": 512,
    "margin": 4,
    "errorCorrectionLevel": "M",
    "dark": "#0f172a",
    "light": "#ffffff"
  }
}),
  redirect: 'error', signal: AbortSignal.timeout(30000)
});
if (!response.ok) throw new Error('HTTP '+response.status+' requestId='+response.headers.get('X-Request-Id'));
const result = await response.json();
console.log(result);
```

## Python

```python
# Python 3.10+; pip install requests
import os
import requests
headers = {
  "Authorization": "Bearer " + os.environ["AGILINK_API_KEY"],
  "Idempotency-Key": "10000000-0000-4000-8000-000000000001"
}
response = requests.request(
    'POST', 'https://api.staging.agilink.io/v1/qr-codes',
    headers=headers, json={"appId":"app_loja","linkId":"go.example.com~-ofertas~-tenis","name":"Vitrine","style":{"size":512,"margin":4,"errorCorrectionLevel":"M","dark":"#0f172a","light":"#ffffff"}},
    timeout=30, allow_redirects=False)
if not 200 <= response.status_code < 300:
    raise RuntimeError(f'HTTP {response.status_code}; requestId={response.headers.get("X-Request-Id")}')
result = response.json()
print(result)
```

## Response 201

Criado. Exemplo fictício.

| Header | Significado | Exemplo |
| --- | --- | --- |
| `X-Request-Id` | Identificador gerado pelo servidor, inclusive para falhas e replays. | conforme resposta |
| `Cache-Control` | Respostas administrativas não podem ser armazenadas. | no-store, no-transform |
| `ETag` | Revisão forte, a enviar em If-Match na alteração. | "20000000-0000-4000-8000-000000000001" |
| `Location` | Recurso criado. | /v1/qr-codes/90000000-0000-4000-8000-000000000002 |

```json
{
  "data": {
    "id": "90000000-0000-4000-8000-000000000002",
    "appId": "app_loja",
    "linkId": "go.example.com~-ofertas~-tenis",
    "url": "https://go.example.com/ofertas/tenis",
    "name": "Vitrine",
    "style": {
      "size": 512,
      "margin": 4,
      "errorCorrectionLevel": "M",
      "dark": "#0f172a",
      "light": "#ffffff"
    },
    "revision": "20000000-0000-4000-8000-000000000001",
    "createdAt": "2026-10-19T20:00:00Z",
    "updatedAt": "2026-10-19T20:00:00Z"
  },
  "meta": {
    "requestId": "req_00000000000040008000000000000001"
  }
}
```

| Campo | Tipo | Obrigatório | Significado e limites |
| --- | --- | --- | --- |
| `data` | QrCode | sim | Resultado tipado da operação.  |
| `data.id` | string | sim | Identificador estável do recurso. uuid |
| `data.appId` | AppId | sim | Aplicativo proprietário; precisa estar autorizado.  |
| `data.linkId` | LinkId | sim | Identidade composta do link.  |
| `data.url` | string | sim | Endereço do recurso; não acrescente credenciais. Até 4096 caracteres; uri; Formato validado pelo schema |
| `data.name` | string | sim | Nome de exibição. Até 100 caracteres; Formato validado pelo schema |
| `data.style` | QrStyle | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.style.size` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo. Mínimo 256; Máximo 1024 |
| `data.style.margin` | integer | sim | Valor tipado; formato e restrições completos no schema abaixo. Mínimo 4; Máximo 16 |
| `data.style.errorCorrectionLevel` | M / Q / H | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.style.dark` | #000000 / #0f172a | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.style.light` | objeto | sim | Valor tipado; formato e restrições completos no schema abaixo.  |
| `data.revision` | string | sim | Revisão forte para If-Match; muda ao editar. uuid |
| `data.createdAt` | string | sim | Instante de criação com fuso. date-time |
| `data.updatedAt` | string | sim | Instante da última alteração. date-time |
| `meta` | Meta | sim | Correlação e informações da resposta.  |
| `meta.requestId` | RequestId | sim | Identificador de correlação gerado pelo servidor.  |

## Falhas, revisão e repetição

Idempotency-Key UUID v4 é obrigatório, por intenção e credencial, por 24 horas. Em resultado incerto, repita exatamente o mesmo método, URL, corpo, revisão e chave. Alterar a intenção exige nova chave. Segredos de emissão não são reexibidos. Esta operação não exige If-Match. Não faça retry automático ilimitado.

| Status | Significado |
| --- | --- |
| 400 | Cabeçalho, query, cursor ou JSON inválido. |
| 401 | Credencial inválida, expirada ou revogada. |
| 403 | Operação sem permissão ou capacidade desabilitada. |
| 404 | Recurso inexistente ou fora dos aplicativos autorizados. |
| 409 | Conflito de identidade/idempotência; operação em andamento ou segredo já exibido. |
| 413 | Corpo excede o limite. |
| 415 | Content-Type incompatível. |
| 422 | JSON bem formado com dados de domínio inválidos. |
| 429 | Quota excedida. Respeitar Retry-After. |
| 500 | Falha interna. Use requestId para diagnóstico. |
| 503 | Dependência indisponível; resultado da mutação pode ser incerto. |

### Exemplo 401

```json
{
  "error": {
    "code": "unauthenticated",
    "message": "Credencial inválida, expirada ou revogada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#unauthenticated"
  }
}
```

### Exemplo 403

```json
{
  "error": {
    "code": "insufficient_permission",
    "message": "Operação sem permissão ou capacidade desabilitada.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#insufficient-permission"
  }
}
```

### Exemplo 409

```json
{
  "error": {
    "code": "idempotency_conflict",
    "message": "Conflito de identidade/idempotência; operação em andamento ou segredo já exibido.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#idempotency-conflict"
  }
}
```

### Exemplo 429

```json
{
  "error": {
    "code": "rate_limited",
    "message": "Quota excedida. Respeitar Retry-After.",
    "requestId": "req_00000000000040008000000000000001",
    "documentationUrl": "https://docs.agilink.io/api/errors/#rate-limited"
  }
}
```

## Schema completo e próximos passos

<details><summary>Schema de request</summary>

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "appId": {
      "$ref": "#/components/schemas/AppId"
    },
    "linkId": {
      "$ref": "#/components/schemas/LinkId"
    },
    "name": {
      "type": "string",
      "maxLength": 100,
      "minLength": 1,
      "pattern": "^[^\\u0000-\\u001f\\u007f]+$"
    },
    "style": {
      "$ref": "#/components/schemas/QrStyle"
    }
  },
  "required": [
    "appId",
    "linkId",
    "name"
  ]
}
```

</details>

<details><summary>Schema de response</summary>

```json
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "data": {
      "$ref": "#/components/schemas/QrCode"
    },
    "meta": {
      "$ref": "#/components/schemas/Meta"
    }
  },
  "required": [
    "data",
    "meta"
  ]
}
```

</details>

[Convenções e limites](/api/contratos/) · [Erros](/api/errors/) · [Receitas completas](/receitas/) · [Guia funcional](/produto/qr/).