Dokumentacja API

API Reference

RESTful API do integracji Zaofertuj z Twoimi systemami. Automatyzuj procesy i buduj własne integracje.

Autentykacja

Wszystkie żądania API wymagają autentykacji za pomocą tokena Bearer. Token otrzymujesz po zalogowaniu.

Authorization: Bearer YOUR_ACCESS_TOKEN

# Przykład w cURL:
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
     https://zaofertuj.app/api/v1/offers

Endpointy podstawowe

Oferty

GET /api/v1/offers

Pobierz listę wszystkich ofert

POST /api/v1/offers

Utwórz nową ofertę

GET /api/v1/offers/{id}

Pobierz szczegóły oferty

PUT /api/v1/offers/{id}

Aktualizuj ofertę

Produkty

GET /api/v1/products

Pobierz listę produktów

POST /api/v1/products

Dodaj nowy produkt

GET /api/v1/products/{id}

Pobierz szczegóły produktu

Katalogi

POST /api/v1/catalogs/import

Import produktów z pliku (CSV, Excel, PDF)

GET /api/v1/catalogs

Pobierz listę katalogów

Przykład użycia

# Utworzenie oferty
POST /api/v1/offers
Content-Type: application/json

{
  "client_name": "Firma XYZ",
  "client_email": "kontakt@firma.pl",
  "items": [
    {
      "product_id": 123,
      "quantity": 10,
      "unit_price": 1500.00
    }
  ],
  "discount_percent": 5,
  "valid_until": "2025-12-31"
}

Webhooks

Webhooks pozwalają na otrzymywanie powiadomień o zdarzeniach w systemie (np. nowa oferta, zmiana statusu).

Dostępne zdarzenia:

• offer.created – utworzono nową ofertę
• offer.updated – zaktualizowano ofertę
• offer.status_changed – zmieniono status oferty

Konfiguracja:

Webhooks konfigurujesz w ustawieniach firmy. Podaj URL endpointu, który ma otrzymywać powiadomienia.

Limity i rate limiting

• Domyślny limit: 1000 żądań na godzinę na konto
• Rate limiting jest stosowany per endpoint
• W odpowiedzi otrzymujesz nagłówki z informacją o limitach
• Przy przekroczeniu limitu otrzymasz kod odpowiedzi 429

📚 Więcej informacji

Pełna dokumentacja API z przykładami i szczegółowym opisem wszystkich endpointów jest dostępna po zalogowaniu w sekcji "Integracje".

Dla zaawansowanych integracji możesz również użyć GraphQL API dostępnego pod adresem /api/graphql.

Powiązane dokumenty

Szybki start

Podstawy korzystania z platformy

Bezpieczeństwo

Runbooki bezpieczeństwa i SLA

Potrzebujesz pomocy z integracją?

Skontaktuj się z naszym zespołem technicznym lub sprawdź centrum pomocy.

Skontaktuj się Centrum pomocy