API Reference

REST API

ProperSend udostępnia REST API do programistycznej integracji z systemem. Możesz programowo zarządzać leadami, kampaniami, skrzynkami i statystykami.

🎯 Kiedy używać: Gdy chcesz zautomatyzować operacje – np. dodawać leady z własnego systemu, pobierać statystyki do dashboardu, integrować ProperSend z CRM-em lub narzędziami no-code (Zapier, Make).

Przejdź do: app.propersend.pl/docs (Swagger UI z pełną dokumentacją) Klucze API: app.propersend.pl/settings?tab=api-keys

Autentykacja

Wszystkie zapytania do API wymagają autentykacji przez API Key przekazywany w nagłówku Authorization:

Authorization: Bearer pro_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Klucze API są zarządzane w ustawieniach organizacji. Klucz ma prefiks pro_ – to ułatwia identyfikację w logach.

Scopes

Każdy klucz API ma określony zakres uprawnień – twórz klucze z minimalnymi uprawnieniami (zasada najmniejszego przywileju):

| Scope | Opis | Przykład użycia | |-------|------|----------------| | crm:read | Odczyt leadów i list | Pobieranie danych do zewnętrznego CRM | | crm:write | Tworzenie i edycja leadów | Automatyczne dodawanie leadów z formularza na stronie | | campaigns:read | Odczyt kampanii | Monitoring statusu kampanii | | campaigns:write | Tworzenie i edycja kampanii | Automatyczne uruchamianie kampanii z zewnętrznego systemu | | mailboxes:read | Odczyt skrzynek | Sprawdzanie stanu skrzynek | | analytics:read | Odczyt statystyk | Pobieranie danych do raportów |

Rate limiting

API posiada rate limiting, aby chronić przed nadużyciami:

| Limit | Window | Dotyczy | |-------|--------|---------| | 60 requests | 1 minuta | Token | | 1000 requests | 1 godzina | Token |

W nagłówkach odpowiedzi znajdziesz informacje o limicie:

• X-RateLimit-Limit – maksymalna liczba zapytań
• X-RateLimit-Remaining – pozostała liczba zapytań
• X-RateLimit-Reset – timestamp resetu limitu

💡 Tip: Jeśli potrzebujesz więcej zapytań, rozważ użycie webhooków zamiast pollingu – webhooki wysyłają dane w czasie rzeczywistym bez zużywania rate limitu.

Endpointy

Pełna dokumentacja endpointów dostępna jest w Swagger UI. Główne grupy:

| Grupa | Opis | Główny endpoint | |-------|------|----------------| | CRM | Zarządzanie leadami i listami | /api/v1/crm | | Campaigns | Kampanie i sekwencje | /api/v1/campaigns | | Mailboxes | Skrzynki pocztowe | /api/v1/mailboxes | | Analytics | Statystyki i metryki | /api/v1/analytics | | Webhooks | Zarządzanie webhookami | /api/v1/webhooks |

MCP Server

ProperSend udostępnia Model Context Protocol (MCP) Server – umożliwia agentom AI (Cursor, Claude, ChatGPT) bezpośrednią integrację z systemem bez ręcznego pisania zapytań API.

Dostępne narzędzia MCP

| Narzędzie | Opis | |-----------|------| | crm_search | Wyszukiwanie leadów po kryteriach | | crm_get | Pobranie szczegółów konkretnego leada | | campaign_list | Lista wszystkich kampanii | | campaign_get | Szczegóły kampanii wraz ze statystykami | | mailbox_list | Lista skonfigurowanych skrzynek |

Konfiguracja MCP dla Cursor / Claude

{
  "mcpServers": {
    "propersend": {
      "command": "npx",
      "args": ["@propersend/mcp-server"],
      "env": {
        "PROPERSEND_API_KEY": "twój_klucz_api"
      }
    }
  }
}

MCP Server to najprostszy sposób na integrację ProperSend z asystentami AI – agent może odczytywać leady, sprawdzać kampanie i pobierać statystyki w czasie rzeczywistym.