Saltearse al contenido

Organizaciones y Workspaces

Descripción general

qr3.app utiliza una jerarquía de dos niveles:

Organization (Firma/Agentur)
└── Workspace 1 (Kunde A)
└── Workspace 2 (Kunde B)
└── Workspace 3 (Internes Team)
  • Organización — nivel superior, asociada a una cuenta y plan de Stripe
  • Workspace — área aislada para códigos QR, escaneos y API-keys

API de Organizaciones

GET /v1/organizations

Devuelve la organización a la que pertenece la API-key actual.

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

GET /v1/organizations/usage

Devuelve el uso en tiempo real de la organización frente a los límites del plan (sumado de todos los Workspaces y calculado en vivo): scans para el mes de facturación actual (frente a max_scans_per_month) y dynamic_codes, la cantidad de códigos dinámicos activos (frente a max_dynamic_codes). Ninguno de los dos se bloquea al alcanzar el límite; utiliza este endpoint para mostrar el uso y avisos de actualización (upgrade).

Ventana de terminal
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

Crea una nueva organización.

Ventana de terminal
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:

CampoTipoObligatorioDescripción
namestringNombre para mostrar (máx. 255 caracteres)
slugstringAmigable para URL, único (mín. 2, máx. 63 caracteres, solo a-z0-9-)
billing_emailstringCorreo electrónico de facturación

PATCH /v1/organizations/:id

Ventana de terminal
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

Eliminación lógica (soft-delete) de la organización. Todos los Workspaces y códigos QR asociados se conservan, pero ya no son accesibles.


API de Workspaces

GET /v1/workspaces

Listar todos los Workspaces de la organización.

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

POST /v1/workspaces

Crear un nuevo Workspace.

Ventana de terminal
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:

CampoTipoPor defectoDescripción
namestringNombre para mostrar (obligatorio)
slugstringAmigable para URL, único por organización (obligatorio)
default_localestringdeIdioma predeterminado
approval_requiredbooleanfalseActivar flujo de trabajo de aprobación
primary_colorstringColor de marca (#RRGGBB)

Límites del plan:

PlanMáx. Workspaces
Free1
Pro3
Business10
AgencyIlimitado

PATCH /v1/workspaces/:id

Ventana de terminal
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

Archiva el Workspace. No se puede aplicar al propio Workspace.


Audit-Logs

GET /v1/audit-logs

Registro rastreable de todos los cambios en el Workspace.

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

Parámetros de consulta:

ParámetroTipoDescripción
resource_typestringFiltrar por recurso: codes, api_keys, webhooks, workspaces
resource_idstringFiltrar por ID de recurso específico
actionstringFiltrar por acción (p. ej., codes.created)
cursorstringCursor de paginación
limitintegerMáx. 100 (por defecto: 50)

Ejemplo de respuesta:

{
"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"
}
]
}