Organizações & Workspaces

Visão Geral

O qr3.app utiliza uma hierarquia de dois níveis:

Organization (Firma/Agentur)
  └── Workspace 1 (Kunde A)
  └── Workspace 2 (Kunde B)
  └── Workspace 3 (Internes Team)

Organização — nível superior, associada a uma conta Stripe e plano
Workspace — área isolada para QR Codes, scans e API-Keys

API de Organizações

`GET /v1/organizations`

Retorna a organização à qual a API-Key atual pertence.

curl https://qr3.app/v1/organizations \
  -H "Authorization: Bearer qr3_sk_..."

`GET /v1/organizations/usage`

Retorna o uso em tempo real da organização em relação aos limites do plano — somado de todos os workspaces e calculado ao vivo: scans para o mês de faturamento atual (em relação a max_scans_per_month) e dynamic_codes, o número de códigos dinâmicos ativos (em relação a max_dynamic_codes). Nenhum dos dois é bloqueado ao atingir o limite; utilize este endpoint para exibir o uso e avisos de upgrade.

curl https://qr3.app/v1/organizations/usage \
  -H "Authorization: Bearer qr3_sk_..."

{
  "data": {
    "scans": {
      "used": 4120,
      "limit": 5000,
      "usage_pct": 82,
      "remaining": 880,
      "period": "2026-06",
      "period_start": "2026-06-01T00:00:00.000Z"
    },
    "dynamic_codes": {
      "used": 142,
      "limit": 500,
      "usage_pct": 28,
      "remaining": 358
    }
  }
}

`POST /v1/organizations`

Cria uma nova organização.

curl -X POST https://qr3.app/v1/organizations \
  -H "Authorization: Bearer qr3_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Digital Heroes GmbH",
    "slug": "digital-heroes",
    "billing_email": "[email protected]"
  }'

Campos:

Campo	Tipo	Obrigatório	Descrição
`name`	string	✅	Nome de exibição (máx. 255 caracteres)
`slug`	string	✅	Amigável para URL, único (mín. 2, máx. 63 caracteres, apenas `a-z0-9-`)
`billing_email`	string	—	E-mail de faturamento

`PATCH /v1/organizations/:id`

curl -X PATCH https://qr3.app/v1/organizations/org_a1b2c3 \
  -H "Authorization: Bearer qr3_sk_..." \
  -H "Content-Type: application/json" \
  -d '{ "name": "Digital Heroes AG", "billing_email": "[email protected]" }'

`DELETE /v1/organizations/:id`

Exclusão lógica (soft-delete) da organização. Todos os workspaces e QR Codes associados são mantidos, mas deixam de estar acessíveis.

API de Workspaces

`GET /v1/workspaces`

Listar todos os workspaces da organização.

curl https://qr3.app/v1/workspaces \
  -H "Authorization: Bearer qr3_sk_..."

`POST /v1/workspaces`

Criar um novo workspace.

curl -X POST https://qr3.app/v1/workspaces \
  -H "Authorization: Bearer qr3_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Kunde Bäckerei Schmidt",
    "slug": "baeckerei-schmidt",
    "default_locale": "de",
    "primary_color": "#8B4513",
    "approval_required": false
  }'

Campos:

Campo	Tipo	Padrão	Descrição
`name`	string	—	Nome de exibição (obrigatório)
`slug`	string	—	Amigável para URL, único por organização (obrigatório)
`default_locale`	string	`de`	Idioma padrão
`approval_required`	boolean	`false`	Ativar fluxo de aprovação
`primary_color`	string	—	Cor da marca (`#RRGGBB`)

Limites do Plano:

Plano	Máx. Workspaces
Free	1
Pro	3
Business	10
Agency	Ilimitado

`PATCH /v1/workspaces/:id`

curl -X PATCH https://qr3.app/v1/workspaces/ws_xyz789 \
  -H "Authorization: Bearer qr3_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Neuer Name",
    "approval_required": true,
    "custom_domain": "qr.baeckerei-schmidt.de"
  }'

`DELETE /v1/workspaces/:id`

Arquiva o workspace. Não pode ser aplicado ao próprio workspace.

Logs de Auditoria

`GET /v1/audit-logs`

Registro rastreável de todas as alterações no workspace.

curl "https://qr3.app/v1/audit-logs?resource_type=codes&limit=50" \
  -H "Authorization: Bearer qr3_sk_..."

Parâmetros de Query:

Parâmetro	Tipo	Descrição
`resource_type`	string	Filtrar por recurso: `codes`, `api_keys`, `webhooks`, `workspaces`
`resource_id`	string	Filtrar por ID de recurso específico
`action`	string	Filtrar por ação (ex: `codes.created`)
`cursor`	string	Cursor de paginação
`limit`	integer	Máx. 100 (padrão: 50)

Exemplo de Resposta:

{
  "data": [
    {
      "id": "aud_a1b2c3",
      "actor_type": "api",
      "action": "codes.created",
      "resource_type": "codes",
      "resource_id": "qr_xyz123",
      "changes": {},
      "created_at": "2026-03-15T10:00:00.000Z"
    }
  ]
}