REST API · v1

Dokumentacja dla Deweloperów

Zintegruj Sendatip z własnymi systemami. Pobieraj pule, transakcje i analizy bezpośrednio przez nasze REST API.

Base URLhttps:/.sendatip.de/api/api/v1

Uwierzytelnianie

Wszystkie żądania API muszą być uwierzytelnione ważnym kluczem API. Wyślij klucz w nagłówku HTTP X-API-Key.

Klucze API możesz tworzyć w ustawieniach. Przejdź do ustawień →

curl https://api.sendatip.de/api/v1/pools \
  -H "X-API-Key: sk_live_your_key_here"

GET/v1/pools

Lista pul

Zwraca wszystkie pule Twojej organizacji – wraz z bezpośrednim linkiem do napiwku dla każdej puli.

Brak parametrów zapytania

Przykładowe żądanie

curl https://api.sendatip.de/api/v1/pools \
  -H "X-API-Key: sk_live_your_key_here"

Przykładowa odpowiedź

{
  "success": true,
  "pools": [
    {
      "id": "uuid",
      "code": "HOTEL-BAR",
      "name": "Hotel Bar",
      "description": "Trinkgeld für die Hotelbar",
      "is_active": true,
      "created_at": "2026-01-15T10:00:00Z",
      "tip_url": "https://sendatip.de/tip/HOTEL-BAR"
    }
  ]
}

GET/v1/pools/:code/qr

Generowanie kodu QR

Zwraca kod QR dla puli jako obraz PNG lub SVG. Idealny do drukarek paragonów, wyświetlaczy POS lub układów do druku.

Parameter	Typ	Pflicht	Beschreibung
code	string	✓	Kod puli (np. HOTEL-BAR)
format	png\|svg	–	Format wyjściowy: png (domyślny) lub svg
size	number	–	Szerokość w pikselach (100–1000, domyślnie: 300)

Przykładowe żądanie

# PNG herunterladen
curl "https://api.sendatip.de/api/v1/pools/HOTEL-BAR/qr?format=png&size=400" \
  -H "X-API-Key: sk_live_your_key_here" \
  --output qr-hotel-bar.png

# SVG als String
curl "https://api.sendatip.de/api/v1/pools/HOTEL-BAR/qr?format=svg" \
  -H "X-API-Key: sk_live_your_key_here"

GET/v1/transactions

Transakcje

Zwraca zakończone transakcje Twojej organizacji. Filtrowalne według daty i puli – idealne do księgowości lub eksportu.

Parameter	Typ	Pflicht	Beschreibung
from	date	–	Data początkowa (RRRR-MM-DD)
to	date	–	Data końcowa (RRRR-MM-DD)
pool_code	string	–	Tylko transakcje z określonej puli
limit	number	–	Liczba wyników (maks. 500, domyślnie: 50)
offset	number	–	Offset dla paginacji (domyślnie: 0)

Przykładowe żądanie

curl "https://api.sendatip.de/api/v1/transactions?from=2026-01-01&to=2026-06-30&limit=100" \
  -H "X-API-Key: sk_live_your_key_here"

Przykładowa odpowiedź

{
  "success": true,
  "transactions": [
    {
      "id": "uuid",
      "amount": 500,
      "currency": "eur",
      "status": "completed",
      "created_at": "2026-06-15T14:23:00Z",
      "pool": { "code": "HOTEL-BAR", "name": "Hotel Bar" },
      "recipient": { "display_name": "Maria M.", "email": "maria@example.com" }
    }
  ],
  "meta": { "limit": 100, "offset": 0 }
}

GET/v1/analytics/summary

Podsumowanie Analytics

Zwraca podsumowanie dla wybranego okresu: łączny przychód, liczba transakcji, średni napiwek i najlepsza pula.

Parameter	Typ	Pflicht	Beschreibung
from	date	–	Data początkowa (RRRR-MM-DD)
to	date	–	Data końcowa (RRRR-MM-DD)

Przykładowe żądanie

curl "https://api.sendatip.de/api/v1/analytics/summary?from=2026-01-01&to=2026-06-30" \
  -H "X-API-Key: sk_live_your_key_here"

Przykładowa odpowiedź

{
  "success": true,
  "summary": {
    "total_amount": 125400,
    "transaction_count": 312,
    "average_amount": 402,
    "currency": "eur",
    "top_pool": {
      "code": "HOTEL-BAR",
      "name": "Hotel Bar",
      "amount": 48200
    }
  }
}

Kody błędów

Wszystkie błędy są zwracane jako JSON z polami error.code i error.message.

HTTP	Code	Znaczenie
401	INVALID_API_KEY	Brak klucza API, nieprawidłowy lub zły format
401	API_KEY_REVOKED	Klucz API został unieważniony
404	POOL_NOT_FOUND	Pula z tym kodem nie istnieje lub nie należy do Twojej organizacji
429	RATE_LIMITED	Zbyt wiele żądań – proszę przestrzegać limitów
500	FETCH_ERROR	Wewnętrzny błąd serwera