Szybki start z API

Ten przewodnik przeprowadzi Cię od zera do subskrybenta dodanego do jednego z Twoich tematów, korzystając z Railmail Public API.

Szukasz pierwszych kroków w aplikacji Railmail? Zobacz Pierwsze kroki w Przewodniku użytkownika.

Wymagania wstępne

Zanim zaczniesz, potrzebujesz:

Projektu Railmail z kluczem API przypisanym do projektu (format rm_live_... lub rm_test_...). Utwórz go w aplikacji w Ustawienia → Klucze API; zobacz Klucze API. Do tego przewodnika klucz potrzebuje zakresów topics:read i subscribers:write (lub Pełnego dostępu).
Narzędzia do wykonywania zapytań HTTP: curl, Postman lub klienta HTTP w Twoim języku.

Podczas integracji używaj klucza rm_test_..., aby nie ruszać danych produkcyjnych.

Dodaj subskrybenta do tematu

Ustaw klucz API

Zapisz klucz w zmiennej środowiskowej, aby nie wklejać go do każdego zapytania.

export RAILMAIL_API_KEY="rm_test_twoj_klucz"

Sprawdź klucze tematów

Wylistuj tematy w swoim projekcie i zanotuj topicKey, do którego chcesz zapisać użytkowników.

curl https://api.railmail.app/api/v1/topics \
  -H "X-API-Key: $RAILMAIL_API_KEY"

Utwórz subskrybenta i zapisz go

Utwórz subskrybenta i zapisz go do tematu w jednym zapytaniu, podając topicKeys oraz consent.

curl -X POST https://api.railmail.app/api/v1/subscribers \
  -H "X-API-Key: $RAILMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "topicKeys": ["newsletter"],
    "consent": "GRANTED"
  }'

Jeśli temat korzysta z double opt-in, zgoda zostaje utworzona jako PENDING_CONFIRMATION, a użytkownik musi ją potwierdzić przez otrzymaną wiadomość, zanim zostanie uznany za zapisanego.

Zweryfikuj

Pobierz subskrybenta, aby potwierdzić zapis.

curl https://api.railmail.app/api/v1/subscribers/user@example.com \
  -H "X-API-Key: $RAILMAIL_API_KEY"

Następne kroki

Przeglądaj wszystkie endpointy

Subskrybenci, kampanie, segmenty, automatyzacje i więcej.

Uwierzytelnianie i zakresy

Zrozum, co może dany klucz i jak go zabezpieczyć.

Potrzebujesz pomocy? Napisz na support@railmail.app.

​Wymagania wstępne

​Dodaj subskrybenta do tematu

​Następne kroki

Przeglądaj wszystkie endpointy

Uwierzytelnianie i zakresy

Wymagania wstępne

Dodaj subskrybenta do tematu

Następne kroki