Referência da API Zapier
Documentação completa da API para a integração QR Code Maker com Zapier. Inclui autenticação OAuth 2.0, todos os endpoints, formatos de requisição/resposta e webhooks.
Referência completa da API para integrar o QR Code Maker com o Zapier. Esta documentação cobre autenticação, todos os endpoints, formatos de requisição/resposta e eventos de webhook.
URL Base
https://qr-code-maker.app
Autenticação
A API usa OAuth 2.0 com fluxo de código de autorização.
Fluxo OAuth 2.0
- Requisição de Autorização - Redirecionar usuário para autorizar
- Código de Autorização - Usuário aprova, recebe código
- Troca de Token - Trocar código por token de acesso
- Requisições da API - Usar token Bearer em todas as requisições
- Atualização de Token - Atualizar quando token de acesso expirar
Endpoint de Autorização
GET /oauth/authorize
Parâmetros:
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
client_id | string | Sim | Seu ID de cliente OAuth |
redirect_uri | string | Sim | URL de redirecionamento |
response_type | string | Sim | Deve ser code |
state | string | Sim | String para proteção CSRF |
scope | string | Não | Escopos separados por espaço |
Escopos Disponíveis:
| Escopo | Descrição |
|---|---|
qr_codes:read | Ler códigos QR |
qr_codes:write | Criar, atualizar, deletar |
analytics:read | Acessar estatísticas |
webhooks:write | Gerenciar webhooks |
Troca de Token
POST /api/oauth/token
Tempos de Vida:
| Token | Duração |
|---|---|
| Código de autorização | 10 minutos |
| Token de acesso | 1 hora |
| Refresh token | 30 dias |
Atualização de Token
POST /api/oauth/refresh
Endpoints da API
Todas as requisições requerem token Bearer:
Authorization: Bearer qrc_at_xxxxxxxx
Testar Conexão
GET /api/zapier/me
Listar Códigos QR
GET /api/zapier/qr
Criar Código QR
POST /api/zapier/qr
Tipos Suportados:
| Tipo | Campos |
|---|---|
website | { "url": "https://..." } |
vcard | { "firstName": "", "lastName": "", ... } |
wifi | { "ssid": "", "password": "", "security": "WPA" } |
email | { "email": "", "subject": "", "body": "" } |
sms | { "phone": "", "message": "" } |
phone | { "phone": "" } |
text | { "text": "" } |
event | { "title": "", "startDate": "", "endDate": "", "location": "" } |
Obter Código QR
GET /api/zapier/qr/{id}
Atualizar Código QR
PATCH /api/zapier/qr/{id}
Deletar Código QR
DELETE /api/zapier/qr/{id}
Pesquisar
GET /api/zapier/qr/search
Análises
GET /api/zapier/qr/{id}/analytics
Pastas
GET /api/zapier/folders
Webhooks
Inscrever
POST /api/zapier/webhooks/subscribe
Eventos:
| Evento | Descrição |
|---|---|
qr.scanned | QR escaneado |
qr.created | QR criado |
qr.milestone.100 | 100 escaneamentos |
qr.milestone.500 | 500 escaneamentos |
qr.milestone.1000 | 1.000 escaneamentos |
qr.milestone.5000 | 5.000 escaneamentos |
qr.milestone.10000 | 10.000 escaneamentos |
Cancelar Inscrição
DELETE /api/zapier/webhooks/{id}
Tratamento de Erros
Códigos HTTP
| Status | Descrição |
|---|---|
200 | Sucesso |
201 | Criado |
204 | Sem Conteúdo |
400 | Requisição Inválida |
401 | Não Autorizado |
403 | Proibido |
404 | Não Encontrado |
422 | Erro de Validação |
429 | Limite Excedido |
500 | Erro do Servidor |
Limite de Taxa
- Limite: 100 requisições por minuto por token
Começar
- Visite nossa integração Zapier
- Autorize o QR Code Maker
- Crie seu primeiro Zap
Suporte
Dúvidas? Contate support@qr-code-maker.app.