Dokumentacja API Zapier
Pełna dokumentacja API dla integracji QR Code Maker z Zapier. Zawiera uwierzytelnianie OAuth 2.0, wszystkie endpointy, formaty żądań/odpowiedzi i webhooki.
Pełna dokumentacja API do integracji QR Code Maker z Zapier. Ta dokumentacja obejmuje uwierzytelnianie, wszystkie endpointy, formaty żądań/odpowiedzi i zdarzenia webhooków.
Bazowy URL
https://qr-code-maker.app
Uwierzytelnianie
API używa OAuth 2.0 z przepływem kodu autoryzacyjnego.
Przepływ OAuth 2.0
- Żądanie autoryzacji - Przekierowanie użytkownika do autoryzacji
- Kod autoryzacyjny - Użytkownik zatwierdza, otrzymuje kod
- Wymiana tokena - Wymiana kodu na token dostępu
- Żądania API - Używanie tokenu Bearer dla wszystkich żądań
- Odświeżanie tokenu - Odświeżanie po wygaśnięciu tokenu dostępu
Endpoint autoryzacji
GET /oauth/authorize
Parametry:
| Parametr | Typ | Wymagany | Opis |
|---|---|---|---|
client_id | string | Tak | Twój OAuth client ID |
redirect_uri | string | Tak | URL przekierowania |
response_type | string | Tak | Musi być code |
state | string | Tak | Ciąg dla ochrony CSRF |
scope | string | Nie | Zakresy oddzielone spacjami |
Dostępne zakresy:
| Zakres | Opis |
|---|---|
qr_codes:read | Odczyt kodów QR |
qr_codes:write | Tworzenie, aktualizowanie, usuwanie |
analytics:read | Dostęp do statystyk |
webhooks:write | Zarządzanie webhookami |
Wymiana tokenu
POST /api/oauth/token
Czas życia tokenów:
| Token | Czas życia |
|---|---|
| Kod autoryzacyjny | 10 minut |
| Token dostępu | 1 godzina |
| Token odświeżania | 30 dni |
Odświeżanie tokenu
POST /api/oauth/refresh
Endpointy API
Wszystkie żądania wymagają tokenu Bearer:
Authorization: Bearer qrc_at_xxxxxxxx
Testuj połączenie
GET /api/zapier/me
Listuj kody QR
GET /api/zapier/qr
Utwórz kod QR
POST /api/zapier/qr
Obsługiwane typy:
| Typ | Pola |
|---|---|
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": "" } |
Pobierz kod QR
GET /api/zapier/qr/{id}
Aktualizuj kod QR
PATCH /api/zapier/qr/{id}
Usuń kod QR
DELETE /api/zapier/qr/{id}
Szukaj
GET /api/zapier/qr/search
Analizy
GET /api/zapier/qr/{id}/analytics
Foldery
GET /api/zapier/folders
Webhooki
Subskrybuj
POST /api/zapier/webhooks/subscribe
Zdarzenia:
| Zdarzenie | Opis |
|---|---|
qr.scanned | Kod QR zeskanowany |
qr.created | Kod QR utworzony |
qr.milestone.100 | 100 skanowań |
qr.milestone.500 | 500 skanowań |
qr.milestone.1000 | 1 000 skanowań |
qr.milestone.5000 | 5 000 skanowań |
qr.milestone.10000 | 10 000 skanowań |
Anuluj subskrypcję
DELETE /api/zapier/webhooks/{id}
Obsługa błędów
Kody statusu HTTP
| Status | Opis |
|---|---|
200 | Sukces |
201 | Utworzono |
204 | Brak zawartości |
400 | Nieprawidłowe żądanie |
401 | Nieautoryzowany |
403 | Zabroniony |
404 | Nie znaleziono |
422 | Błąd walidacji |
429 | Limit przekroczony |
500 | Błąd serwera |
Limit szybkości
- Limit: 100 żądań na minutę na token
Rozpocznij
- Odwiedź naszą integrację Zapier
- Autoryzuj QR Code Maker
- Utwórz swój pierwszy Zap
Wsparcie
Pytania? Skontaktuj się z support@qr-code-maker.app.