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
- Konfiguracja sklepu (zakres
write_storefront) — proces zakupowy, wygląd koszyka (logo, favicon, ikona mobile, kolory, własny CSS), teksty w koszyku, wygląd stron sprzedażowych (kolory, pasek, własny CSS sklepu), rodzaje dostaw i płatności (nazwa w koszyku, koszt, VAT, aktywność), statusy zamówień z mailami, sekwencje wiadomości z automatyzacją
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 imker.pl/salescrm/api/.
4. Klucz API
Aby korzystać z API, potrzebujesz klucza. Utworzysz go w panelu:
- Przejdź do Integracje → API REST i kliknij „Zarządzaj kluczami API”.
- Kliknij „Utwórz nowy klucz”, nazwij go (np. nazwą integracji) i zaznacz tylko potrzebne zakresy. Opcjonalnie ustaw datę wygaśnięcia.
- Skopiuj klucz od razu. Ze względów bezpieczeństwa pokazujemy go tylko raz. Używaj go w nagłówku
X-API-KEY.
Zakresy klucza: read (odczyt danych), write_data (zapis produktów, zamówień, kodów rabatowych, kategorii), write_config (płatności, księgowość i sekrety integracji), write_storefront (wygląd i teksty koszyka) oraz write_subscriptions (subskrypcje klientów).
Bezpieczeństwo kluczy API
Klucz API działa jak hasło do Twojego sklepu, tyle że bez logowania i bez dodatkowej weryfikacji. Kto go ma, może z dowolnego komputera pobrać dane klientów i zamówień (imiona i nazwiska, adresy e-mail, adresy dostawy, numery telefonów), a z zakresami write_… także zmieniać produkty, ceny, zamówienia i konfigurację. Wyciek klucza to wyciek danych osobowych Twoich klientów, a za ich ochronę odpowiadasz jako administrator danych.
- Nie wklejaj klucza do kodu strony ani skryptu w przeglądarce, do repozytorium, maila, komunikatora ani narzędzi AI. Trzymaj go w menedżerze haseł albo w zmiennych środowiskowych serwera.
- Nadawaj tylko potrzebne zakresy. Do raportów i odczytu wystarczy
read. - Twórz osobny klucz dla każdej integracji i każdej firmy zewnętrznej. Odwołasz jeden, reszta dalej działa.
- Klucz dla agencji albo na czas wdrożenia twórz z datą wygaśnięcia.
- Zaglądaj do kolumny ostatniego użycia na liście kluczy. Klucz, którego nic nie używa, odwołaj.
- Kończysz współpracę z agencją albo pracownikiem? Odwołaj ich klucze tego samego dnia.
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