Publiczne REST API (v2)
Integruj SalesCRM z zewnętrznymi systemami za pomocą publicznego REST API — produkty, zamówienia, wyszukiwanie i dane referencyjne.
1. Czym jest publiczne REST API SalesCRM?
SalesCRM udostępnia publiczne REST API, które pozwala na programistyczną integrację z zewnętrznymi systemami. API działa pod ścieżką /api/v1 (nie wymaga osobnej subdomeny), używa formatu JSON i autoryzuje się jednym kluczem API w nagłówku X-API-KEY.
2. Dostępne endpointy
API udostępnia następujące grupy endpointów:
- Produkty — pełne CRUD (tworzenie, odczyt, aktualizacja, usuwanie)
- Kody rabatowe — pełne CRUD plus filtrowanie po nazwie i statusie
- Zamówienia — lista zamówień i szczegóły pojedynczego zamówienia, z filtrami po dacie, statusie, kliencie, produkcie (
product_id/sku) i statusie płatności - Raporty —
/reports/salesi/reports/payments: agregaty przychodów, liczby zamówień i płatności w wybranym okresie z rozbiciem dziennym, tygodniowym lub miesięcznym - Akcje na zamówieniu — aktualizacja statusu, oznaczenie jako rozliczone
- Dane referencyjne — statusy zamówień, metody płatności, sposoby dostawy, kategorie produktów
3. Pełna dokumentacja API
Pełna dokumentacja techniczna API z opisem każdego endpointu, parametrami zapytań, przykładami zapytań curl, strukturą odpowiedzi JSON i kodami błędów dostępna jest na new.imker.pl/salescrm/api/.
4. Klucz API
Aby korzystać z API, potrzebujesz klucza autoryzacyjnego. Wygenerujesz go w panelu administracyjnym:
- Przejdź do Ustawienia → API.
- Kliknij „Wygeneruj klucz API”.
- Skopiuj klucz i użyj go w nagłówku autoryzacji swoich zapytań.
W tym samym miejscu możesz wyłączyć API jednym przełącznikiem, jeśli nie chcesz, aby było dostępne.
5. Dla kogo jest API?
Publiczne REST API v2 jest przeznaczone dla osób i firm, które chcą zintegrować SalesCRM z:
- narzędziami automatyzacji — Zapier, Make (Integromat), n8n
- własnymi systemami CRM lub ERP
- systemami magazynowymi i logistycznymi
- własnymi aplikacjami webowymi i mobilnymi