Dokumentacja API

API v1

Dokumentacja API

Zintegruj generowanie kodów QR, dostosowywanie i analitykę w swoich aplikacjach za pomocą naszego API REST. Twórz potężne przepływy pracy z kodami QR za pomocą zaledwie kilku wywołań API.

Szybki start

Zrób swoje pierwsze wywołanie API w kilka minut. Oto jak stworzyć kod QR:

Uzyskaj swój klucz API

Zarejestruj się lub zaloguj, a następnie odwiedź stronę Programiści, aby utworzyć klucz API.

Zrób swoje pierwsze żądanie

Użyj klucza API w nagłówku X-API-Key:

Przykładowe żądanie

curl -X POST \
  https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "URL",
    "name": "My Website QR",
    "data": {
      "url": "https://example.com"
    }
  }'

Przykładowa odpowiedź

{
  "id": "qr_abc123",
  "type": "URL",
  "name": "My Website QR",
  "shortUrl": "https://ilqr.co/abc123",
  "data": {
    "url": "https://example.com"
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "totalScans": 0
}

Uwierzytelnianie

Wszystkie żądania API wymagają uwierzytelnienia za pomocą klucza API. Dołącz swój klucz w nagłówku żądania:

X-API-Key: your_api_key_here

Wskazówka dotycząca bezpieczeństwa: Nigdy nie ujawniaj swojego klucza API w kodzie po stronie klienta. Zawsze wykonuj wywołania API z serwera lub używaj zmiennych środowiskowych.

Podstawowy URL

Wszystkie punkty końcowe API są względne do następującego podstawowego URL:

https://api.iloveqr.com/api/v1

Limity zapytań

Żądania API są ograniczone, aby zapewnić uczciwe korzystanie i stabilność platformy:

Krótki termin

requests/second

Średni termin

requests/10 seconds

Długi termin

100

requests/minute

Punkty końcowe API

Zbadaj nasze kompleksowe punkty końcowe API zorganizowane według funkcjonalności:

Zarządzanie kodami QR

Twórz, aktualizuj i zarządzaj dynamicznymi kodami QR programowo

Operacje masowe

Twórz setki kodów QR jednocześnie za pomocą importu CSV lub API

Analityka

Śledź skany, lokalizacje, urządzenia i eksportuj szczegółowe raporty

Webhooks

Otrzymuj powiadomienia w czasie rzeczywistym, gdy kody QR są skanowane

Dlaczego warto wybrać nasze API

Szybkie i niezawodne

API o niskiej latencji z 99,9% SLA dostępności

Bezpieczne domyślnie

Uwierzytelnianie klucza API z ograniczonymi uprawnieniami

Ograniczenie zapytań

Hojne limity z jasnymi odpowiedziami na błędy

SDK wkrótce

Pracujemy nad oficjalnymi SDK dla JavaScript, Pythona, PHP i innych. Zarejestruj się, aby otrzymać powiadomienie, gdy będą dostępne.

Potrzebujesz pomocy?

Jeśli masz pytania dotyczące API lub potrzebujesz pomocy, sprawdź te zasoby:

Centrum pomocy Skontaktuj się z pomocą techniczną Panel dewelopera