Braxen API - Nowoczesne rozwiązanie do automatyzacji SMS i e-mail marketing. ## Autoryzacja - WAŻNE! **KLUCZ API JEST SPECYFICZNY DLA PROJEKTU BĄDŹ SMS API!** Każdy projekt w systemie Braxen posiada swój własny, unikalny klucz API (X-API-KEY). - Klucz przypisany do Projektu A **NIE BĘDZIE** działał dla Projektu B - Jeden klucz API = Jeden projekt - Aby zarządzać wieloma projektami, potrzebujesz osobnego klucza dla każdego z nich Większość endpointów wymaga autoryzacji za pomocą klucza API przekazanego w nagłówku `X-API-KEY`. Klucz API można znaleźć w panelu zarządzania projektem bądź w panelu zarzadzania SMS API. ## Funkcjonalności - **Projects** - Zarządzanie projektami i kluczami API (ZACZNIJ OD TEGO!) - **Contacts** - Zarządzanie kontaktami i grupami kontaktów - **SMS Queue** - Wysyłanie pojedynczych i masowych SMS-ów - **SMS History** - Historia wysłanych wiadomości SMS - **SMS Status** - Sprawdzanie statusu wiadomości ## Workflow 1. Pobierz listę swoich projektów: `GET /api/projects` 2. Wybierz projekt i użyj jego klucza API (X-API-KEY) 3. Wykonuj operacje tylko na zasobach tego projektu ## Format odpowiedzi Wszystkie odpowiedzi API są zwracane w formacie JSON. ## Kody błędów - `400` - Błąd walidacji danych wejściowych - `401` - Brak lub nieprawidłowy klucz API / Klucz nie pasuje do projektu - `403` - Brak uprawnień do zasobu - `404` - Nie znaleziono zasobu - `500` - Błąd serwera
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Retrieves a ConstraintViolation resource.
Zgoda na wysyłkę SMS marketingowych (RODO) UWAGA: SMS wysyłane są TYLKO na polskie numery telefonu (+48)
Źródło zgody SMS: 'manual', 'import', 'api', 'form', 'double_opt_in', 'legacy_import' WYMAGANE dla RODO Art. 7.1 - administrator musi wiedzieć SKĄD pochodzi zgoda
Pełna treść zgody SMS (RODO Art. 7.1 - dowód zgody) Przechowujemy dokładną treść klauzuli, którą użytkownik zaakceptował Wymóg: administrator musi być w stanie wykazać, na CO DOKŁADNIE użytkownik wyraził zgodę WYMAGANE dla RODO Art. 7.1
Adres IP z którego udzielono zgody SMS (wymóg RODO - Art. 7.1) Przechowywane do celów dowodowych w przypadku kontroli UODO WYMAGANE dla RODO Art. 7.1 - dowód SKĄD została udzielona zgoda
User Agent przeglądarki z której udzielono zgody SMS Dodatkowe zabezpieczenie zgodności z RODO - pełna ścieżka audytu WYMAGANE dla pełnego audytu RODO
Powód rezygnacji z SMS: 'user_request', 'admin_removal', 'gdpr_request', 'spam_complaint'
Adres IP z którego dodano kontakt (wymóg RODO - Art. 30) Rejestr czynności przetwarzania - obowiązek administratora danych
Adres IP ostatniej aktualizacji kontaktu Pełna historia zmian dla zgodności z RODO
Zwraca wszystkie grupy kontaktów do których należy kontakt
Sprawdza czy kontakt jest odsubskrybowany z danego projektu
Zwraca wszystkie projekty z których kontakt jest odsubskrybowany
Sprawdza czy kontakt ma zgodę na SMS (RODO) UWAGA: System obsługuje TYLKO polskie numery telefonu (+48)
Sprawdza czy numer telefonu jest polski (format +48XXXXXXXXX) System obsługuje TYLKO polskie numery telefonu
Kontakty - zarządzanie odbiorcami w grupach kontaktów. UWAGA: Klucz API (X-API-KEY) jest przypisany do konkretnego projektu. Jeden klucz API działa tylko dla jednego projektu!
Domyślna zgoda na SMS dla nowych kontaktów w grupie (RODO) Gdy TRUE - nowe kontakty dodawane do grupy automatycznie otrzymują zgodę SMS Dotyczy TYLKO polskich numerów (+48)
Data ostatniej zmiany ustawień zgody SMS dla grupy
Zwraca liczbę wszystkich członkostw (włącznie z nieaktywnymi)
Zwraca wszystkie numery telefonów z grupy
Zwraca kontakty z tej grupy które mają zgodę na SMS UWAGA: Sprawdza TYLKO kontakty z polskimi numerami (+48)
Liczba kontaktów z polskimi numerami i zgodą SMS
Grupy kontaktów do organizacji i zarządzania odbiorcami kampanii
Status: draft, scheduled, sending, completed, failed, cancelled
Aktualny etap wysyłki: 0 = główna kampania, 1 = follow-up #1, 2 = follow-up #2, .
Zlicza ile razy kampania była wysyłana ponownie
Zwraca aktualną treść na podstawie wybranego edytora
Kampanie e-mail - przeglądaj kampanie i ich statystyki
Zaszyfrowane hasło email (używane do wysyłania SMTP)
Zwraca pełną nazwę nadawcy z adresem email
Zwraca zamaskowaną wersję hasła (do wyświetlania)
Sprawdza czy konfiguracja SMTP jest kompletna
Sprawdza czy konfiguracja IMAP jest kompletna
Skrzynki pocztowe - przeglądaj konfiguracje bez dostępu do wrażliwych danych
Wymagaj zgody SMS dla wszystkich wysyłek w projekcie (RODO) Gdy TRUE - projekt wymaga zgody SMS dla wszystkich kontaktów System wysyła SMS TYLKO na polskie numery (+48)
Data ostatniej zmiany ustawień zgody SMS dla projektu
Zlicza liczbę grup kontaktów w projekcie
Zlicza liczbę kont email przypisanych do projektu
Sprawdza czy dany kontakt jest odsubskrybowany z tego projektu
Zwraca wszystkie odsubskrybowane kontakty z tego projektu
Zwraca zamaskowaną wersję klucza API do wyświetlania
Projekty - zarządzanie projektami i ich kluczami API. UWAGA: Każdy projekt posiada własny, unikalny klucz API. Klucz przypisany do projektu A nie będzie działał dla projektu B!
Sprawdza czy przekroczono maksymalną liczbę prób
Sprawdza czy SMS jest gotowy do wysłania
Zwraca wartość priorytetu jako int (dla sortowania)
Zarządzanie wiadomościami SMS - wysyłanie, anulowanie, sprawdzanie statusu
Retrieves the collection of EmailCampaign resources.
The collection of EmailCampaign resources
Retrieves the collection of UserEmail resources.
Retrieves the collection of Project resources.
Retrieves the collection of SmsQueue resources.
Retrieves the collection of SmsQueueHistory resources.
The collection of SmsQueueHistory resources
The message associated with the violation