Przejdź do głównej zawartości

Podstawowe koncepcje

Zrozumienie kluczowych koncepcji w Notifer pomoże Ci efektywnie korzystać z usługi.

Tematy

  • Tematy to kanały dla wiadomości. Pomyśl o nich jak o pokojach czatowych lub kanałach RSS.
  • Nazwy tematów są częścią URL: https://app.notifer.io/my-topic
  • Tematy muszą być utworzone jawnie przed publikowaniem wiadomości
  • Twórz tematy przez aplikację webową lub API
  • Każdy może przeglądać publiczne tematy bez uwierzytelnienia
  • Prywatne tematy wymagają uwierzytelnienia

Zasady nazewnictwa tematów

  • Używaj małych liter, cyfr, myślników i podkreślników
  • Długość: 3-64 znaki
  • Przykłady: server-alerts, my_notifications, app123-status

Typy tematów

=== "Publiczny"

```bash
# Każdy może publikować i subskrybować
curl -d "Public announcement" https://app.notifer.io/announcements
```

- **Widoczny** w przeglądarce publicznych tematów o ile tak ustawił właściciel
- Nie wymaga uwierzytelnienia
- Świetny do powiadomień społecznościowych, lub treści bez danych wrażliwych

=== "Prywatny"

Prywatne tematy wymagają uwierzytelnienia do publikowania. Subskrypcja wymaga zgody właściciela lub odkrywalności:

```bash
# Wymaga klucza API lub logowania
curl -d "Confidential data" \
-H "X-API-Key: noti_your_key_here" \
https://app.notifer.io/private-alerts
```

* Pełna kontrola dostępu
* Subskrypcja wymaga zgody właściciela (domyślnie)
* **Opcjonalnie odkrywalny** - umożliwia publiczne subskrypcje tylko do odczytu

=== "Prywatny odkrywalny"

Tematy prywatne mogą być ustawione jako odkrywalne w publicznym katalogu, umożliwiając subskrypcje **tylko do odczytu**:

```bash
# Tylko właściciel/posiadacze tokenów mogą publikować
curl -d "Ogłoszenie firmowe" \
-H "X-API-Key: noti_your_key_here" \
https://app.notifer.io/announcements
```

* Każdy może znaleźć i subskrybować przez katalog
* Subskrybenci otrzymują powiadomienia (tylko odczyt)
* Tylko właściciel i posiadacze tokenów mogą publikować
* Idealne dla ogłoszeń i aktualizacji statusu

Wiadomości

Wiadomości to powiadomienia wysyłane do tematów.

Struktura wiadomości

{
"id": "msg_abc123",
"topic": "my-topic",
"title": "Optional Title",
"message": "Message content",
"priority": 3,
"tags": ["tag1", "tag2"],
"timestamp": "2025-11-02T10:30:00Z"
}

Parametry wiadomości

ParametrOpisDomyślniePrzykład
messageTreść wiadomości (wymagane)-"Server is down"
X-TitleTytuł wiadomościNazwa tematu"Alert"
X-PriorityPoziom priorytetu 1-531 (krytyczny)
X-TagsTagi oddzielone przecinkami[]"server,critical"

Poziomy priorytetów

PriorytetOpisZastosowanieIkona
1KrytycznyKrytyczne problemy, awarie🔴
2WysokiWażne alerty🟠
3Średni (domyślny)Standardowe powiadomienia🔵
4NiskiDrobne aktualizacje
5InformacyjnyNiska ważność, do wiadomości🔷

Szczegółowy opis zachowania priorytetów, filtrowania i najlepszych praktyk -- zobacz Poziomy priorytetów.

Tagi

Tagi pomagają kategoryzować i filtrować wiadomości:

# Wiele tagów
curl -d "Database connection lost" \
-H "X-Tags: database,error,production" \
https://app.notifer.io/alerts

Funkcje tagów:

  • Filtruj subskrypcje według konkretnych tagów
  • Wyszukuj wiadomości po tagach
  • Wizualne wskaźniki w interfejsie

Zaawansowane użycie tagów, strategie tagowania i filtrowanie -- zobacz Tagi.

Odbieranie wiadomości

Aplikacja Web i mobilna (wymagane konto)

Aby przeglądać i odbierać wiadomości w aplikacji Notifer:

  1. Utwórz konto na app.notifer.io
  2. Zaloguj się do aplikacji web lub mobilnej
  3. Przeglądaj lub wyszukuj tematy
  4. Zasubskrybuj tematy, które chcesz śledzić

Powiadomienia push pozwalają otrzymywać alerty nawet gdy aplikacja jest zamknięta:

  • Włącz powiadomienia przeglądarki (web)
  • Zainstaluj aplikację mobilną dla powiadomień push iOS/Android

Dostęp programistyczny (bez konta dla publicznych tematów)

Deweloperzy mogą uzyskać dostęp do publicznych tematów bez uwierzytelnienia:

=== "SSE (Server-Sent Events)"

Strumieniowanie w czasie rzeczywistym dla aplikacji:

```javascript
const eventSource = new EventSource('https://app.notifer.io/my-topic/sse');
eventSource.onmessage = (event) => {
console.log(JSON.parse(event.data));
};
```

=== "CLI"

Strumieniowanie z wiersza poleceń:

```bash
notifer subscribe my-topic
```

=== "API"

Pobierz historię wiadomości:

```bash
curl https://app.notifer.io/my-topic/json
```
Prywatne tematy wymagają uwierzytelnienia

Dla prywatnych tematów musisz podać klucz API, token tematu lub token JWT.

Uwierzytelnianie

Co wymaga konta?

AkcjaPubliczne tematyPrywatne tematy
Tworzenie tematówWymagane kontoWymagane konto
Przeglądanie w aplikacji web/mobilnejWymagane kontoWymagane konto
Subskrypcja (powiadomienia push)Wymagane kontoWymagane konto + uprawnienia dla tematów zespołowych
Publikowanie wiadomościBez kontaWymagane uwierzytelnienie
Dostęp SSE/API (programistyczny)Bez kontaWymagane uwierzytelnienie

Metody uwierzytelniania

=== "Klucze API"

Dla skryptów i integracji:

```bash
curl -H "X-API-Key: noti_your_key_here" \
-d "Automated message" \
https://app.notifer.io/my-private-topic
```

=== "Tokeny dostępu do tematu"

Dla dostępu do konkretnego tematu (zalecane dla automatyzacji):

```bash
curl -H "X-Topic-Token: tk_your_token_here" \
-d "Message" \
https://app.notifer.io/my-private-topic
```

=== "Tokeny JWT"

Dla aplikacji web/mobile po zalogowaniu:

```bash
curl -H "Authorization: Bearer your_jwt_token" \
https://app.notifer.io/api/topics
```

Przechowywanie wiadomości

  • Wiadomości są przechowywane do 60 dni (w zależności od planu)
  • Ostatnie 100 wiadomości na temat jest cache'owanych dla natychmiastowego dostępu
  • Starsze wiadomości są dostępne przez paginację API

Limity

Limity różnią się w zależności od planu subskrypcji:

Zobacz Cennik po szczegóły.

Następne kroki