Referencia de API de Zapier
Documentación completa de la API para la integración de QR Code Maker con Zapier. Incluye autenticación OAuth 2.0, todos los endpoints, formatos de solicitud/respuesta y webhooks.
Referencia completa de la API para integrar QR Code Maker con Zapier. Esta documentación cubre autenticación, todos los endpoints disponibles, formatos de solicitud/respuesta y eventos de webhook.
URL Base
https://qr-code-maker.app
Autenticación
La API utiliza OAuth 2.0 con el flujo de código de autorización.
Flujo OAuth 2.0
- Solicitud de Autorización - Redirigir al usuario para autorizar
- Código de Autorización - El usuario aprueba, recibe el código
- Intercambio de Token - Intercambiar código por token de acceso
- Solicitudes a la API - Usar token Bearer para todas las solicitudes
- Actualización de Token - Actualizar cuando el token de acceso expire
Endpoint de Autorización
GET /oauth/authorize
Parámetros de Consulta:
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
client_id | string | Sí | Tu ID de cliente OAuth |
redirect_uri | string | Sí | URL para redirigir después de la autorización |
response_type | string | Sí | Debe ser code |
state | string | Sí | Cadena aleatoria para protección CSRF |
scope | string | No | Alcances separados por espacios (predeterminado: todos) |
Alcances Disponibles:
| Alcance | Descripción |
|---|---|
qr_codes:read | Leer códigos QR y sus detalles |
qr_codes:write | Crear, actualizar y eliminar códigos QR |
analytics:read | Acceder a estadísticas de escaneo |
webhooks:write | Gestionar suscripciones de webhook |
Intercambio de Token
POST /api/oauth/token
Intercambiar un código de autorización por tokens de acceso y actualización.
Encabezados de Solicitud:
Content-Type: application/x-www-form-urlencoded
Cuerpo de Solicitud:
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
grant_type | string | Sí | Debe ser authorization_code |
code | string | Sí | Código de autorización de la redirección |
redirect_uri | string | Sí | Debe coincidir con el redirect_uri original |
client_id | string | Sí | Tu ID de cliente OAuth |
client_secret | string | Sí | Tu secreto de cliente OAuth |
Respuesta Exitosa (200):
{
"access_token": "qrc_at_xxxxxxxxxxxxxxxx",
"token_type": "Bearer",
"expires_in": 3600,
"refresh_token": "qrc_rt_xxxxxxxxxxxxxxxx",
"scope": "qr_codes:read qr_codes:write analytics:read"
}
Tiempos de Vida de Tokens:
| Token | Duración |
|---|---|
| Código de autorización | 10 minutos |
| Token de acceso | 1 hora |
| Token de actualización | 30 días |
Actualización de Token
POST /api/oauth/refresh
Actualizar un token de acceso expirado.
Nota: Los tokens de actualización se rotan en cada uso. El token de actualización antiguo se invalida.
Endpoints de la API
Todas las solicitudes a la API requieren un token Bearer en el encabezado Authorization:
Authorization: Bearer qrc_at_xxxxxxxx
Probar Conexión
GET /api/zapier/me
Verificar la conexión de la API y recuperar información de la cuenta.
Respuesta Exitosa (200):
{
"id": "user_uuid",
"email": "user@example.com",
"organization_id": "org_uuid",
"organization_name": "My Company"
}
Listar Códigos QR
GET /api/zapier/qr
Recuperar una lista paginada de códigos QR. Los resultados están ordenados por fecha de creación (más recientes primero).
Parámetros de Consulta:
| Parámetro | Tipo | Predeterminado | Descripción |
|---|---|---|---|
page | integer | 1 | Número de página |
limit | integer | 20 | Elementos por página (máx 100) |
folder_id | string | - | Filtrar por carpeta |
status | string | - | Filtrar por estado: active o paused |
type_id | string | - | Filtrar por tipo: website, vcard, wifi, etc. |
Crear Código QR
POST /api/zapier/qr
Crear un nuevo código QR.
Tipos de Códigos QR Soportados:
| ID de Tipo | Campos de Contenido |
|---|---|
website | { "url": "https://..." } |
vcard | { "firstName": "", "lastName": "", "phone": "", "email": "", ... } |
wifi | { "ssid": "", "password": "", "security": "WPA" } |
email | { "email": "", "subject": "", "body": "" } |
sms | { "phone": "", "message": "" } |
phone | { "phone": "" } |
text | { "text": "" } |
event | { "title": "", "startDate": "", "endDate": "", "location": "" } |
Obtener Código QR
GET /api/zapier/qr/{id}
Recuperar un código QR específico por ID.
Actualizar Código QR
PATCH /api/zapier/qr/{id}
Actualizar un código QR existente.
Eliminar Código QR
DELETE /api/zapier/qr/{id}
Eliminar permanentemente un código QR.
Buscar Códigos QR
GET /api/zapier/qr/search
Buscar códigos QR por nombre.
Obtener Analíticas de Código QR
GET /api/zapier/qr/{id}/analytics
Recuperar estadísticas de escaneo para un código QR.
Listar Carpetas
GET /api/zapier/folders
Recuperar todas las carpetas para organizar códigos QR.
Webhooks (REST Hooks)
Suscríbete para recibir notificaciones en tiempo real cuando ocurran eventos.
Suscribirse a Webhook
POST /api/zapier/webhooks/subscribe
Eventos Disponibles:
| Evento | Descripción |
|---|---|
qr.scanned | Código QR fue escaneado |
qr.created | Nuevo código QR creado |
qr.milestone.100 | Código QR alcanzó 100 escaneos |
qr.milestone.500 | Código QR alcanzó 500 escaneos |
qr.milestone.1000 | Código QR alcanzó 1,000 escaneos |
qr.milestone.5000 | Código QR alcanzó 5,000 escaneos |
qr.milestone.10000 | Código QR alcanzó 10,000 escaneos |
Cancelar Suscripción
DELETE /api/zapier/webhooks/{id}
Manejo de Errores
Códigos de Estado HTTP
| Estado | Descripción |
|---|---|
200 | Éxito |
201 | Creado |
204 | Sin Contenido (eliminación exitosa) |
400 | Solicitud Incorrecta |
401 | No Autorizado |
403 | Prohibido |
404 | No Encontrado |
422 | Error de validación |
429 | Límite de tasa excedido |
500 | Error del Servidor |
Límite de Tasa
- Límite: 100 solicitudes por minuto por token de acceso
Comenzar
- Visita nuestra integración de Zapier
- Autoriza QR Code Maker cuando se te solicite
- Crea tu primer Zap
Soporte
¿Preguntas sobre la API? Contacta a support@qr-code-maker.app.