Dla deweloperów

API Klientometru

Backend udostępnia JSON API w Django Ninja. Endpointy panelu używają tokenu użytkownika, ingest klucza workspace/store, a rozszerzenie osobnego tokenu kme_.

Adresy bazowe

Usługa	Produkcja	Rola
API aplikacji	`https://api.klientometr.pl/api`	Auth, workspace, raporty, ingest
Collector	`https://t.klientometr.pl/api`	Lekkie zdarzenia trackingowe
Frontend	`https://klientometr.pl`	Panel, onboarding i dokumentacja

Uwierzytelnianie

Typ	Format	Przeznaczenie
Token użytkownika	`Authorization: Bearer …`	Panel i operacje na workspace
Klucz sklepu	`X-Workspace-API-Key: kmw_…`	Plugin oraz ingest konkretnego sklepu
Klucz workspace legacy	`Authorization: Bearer km_…`	Integracje workspace bez store scope
Token rozszerzenia	`Authorization: Bearer kme_…`	Endpointy /v1/extension

Sekrety są pokazywane tylko przy utworzeniu

Przechowuj je w menedżerze sekretów. Rotacja unieważnia poprzedni klucz, dlatego po rotacji zaktualizuj plugin lub rozszerzenie.

Ingest i plugin

POST/api/v1/events/ingest

Zapisuje RawEvent i zwraca 202 wraz z informacją o duplikacie.

GET/api/v1/plugin/status

Weryfikuje połączenie pluginu, sklep i konfigurację Pixela.

POST/api/v1/plugin/deliveries

Rejestruje potwierdzenia Meta Pixel i CAPI.

cURL · terminalKod

curl --request POST \
  --url https://t.klientometr.pl/api/v1/events/ingest \
  --header "Content-Type: application/json" \
  --header "X-Workspace-API-Key: kmw_REDACTED" \
  --data @purchase.json

Workspace, sklepy i integracje

POST/api/v1/onboarding/bootstrap

Tworzy podstawowy workspace i konfigurację startową.

GET/api/v1/workspaces

Lista dostępnych workspace użytkownika.

GET/api/v1/workspaces/{id}/stores

Sklepy przypisane do workspace.

POST/api/v1/workspaces/{id}/woo/connect

Zapis zweryfikowanego połączenia WooCommerce.

POST/api/v1/workspaces/{id}/woo/import-orders

Import zamówień i opcjonalnie katalogu.

GET/api/v1/workspaces/{id}/meta/oauth/start

Rozpoczyna Meta Business Login.

POST/api/v1/workspaces/{id}/meta/sync

Uruchamia asynchroniczny sync Meta.

GET/api/v1/workspaces/{id}/diagnostics

Zbiorcza diagnostyka workspace.

Raportowanie

GET/api/v1/dashboard/overview

Główne metryki dla workspace i zakresu dat.

GET/api/v1/dashboard/overview-series

Szereg czasowy Overview.

GET/api/v1/dashboard/meta/entities

Kampanie, adsety lub reklamy.

GET/api/v1/dashboard/attribution/orders

Zamówienia i wynik atrybucji.

GET/api/v1/dashboard/attribution/customer-journey

Ścieżka konkretnego zamówienia.

GET/api/v1/dashboard/attribution/discrepancies

Porównanie Klientometr vs Meta.

GET/api/v1/extension/meta/accounts/{account_id}/metrics

Agregaty dla rozszerzenia Chrome.

Statusy i obsługa błędów

HTTP	Znaczenie	Reakcja
202	Zdarzenie przyjęte	Sprawdź accepted i duplicate
400	Niepoprawny payload lub parametr	Popraw dane, nie ponawiaj bez zmiany
401	Brak lub niepoprawny token	Zweryfikuj typ klucza i nagłówek
403	Klucz nie ma dostępu do zasobu	Sprawdź workspace/store scope
404	Nieznany sklep, konto lub job	Odśwież identyfikatory
429	Zbyt wiele żądań	Zastosuj backoff i cache
5xx	Błąd przejściowy usługi	Ponów z wykładniczym backoffem

DalejDiagnostyka ›