Skip to main content
Każde zapytanie do Railmail API musi być uwierzytelnione kluczem API przypisanym do projektu. Zapytania bez ważnego klucza zwracają 401.

​
Klucze API

Klucze mają format rm_(live|test)_<losowy>: Klucz odpowiada dokładnie jednemu projektowi. Wszystkie odczyty i zapisy są automatycznie izolowane do tego projektu i jego tenanta: klucz nie może odczytać ani zmodyfikować danych innego projektu.
Traktuj klucze API jak hasła. Nigdy nie umieszczaj ich w repozytorium ani w kodzie po stronie klienta. Przechowuj je w zmiennych środowiskowych lub menedżerze sekretów.

​
Wysyłanie klucza

Przekaż klucz w nagłówku X-API-Key:
Alternatywnie wyślij go jako token bearer, przydatny z klientami obsługującymi tylko Authorization:
Oba sposoby są równoważne. Użyj tego, który jest wygodniejszy w Twoim kliencie HTTP.

​
Zakresy

Każdy klucz posiada zestaw zakresów (scopes). Każda operacja wymaga określonego zakresu, opisanego w jej opisie (na przykład Requires scope: subscribers:write). Zapytanie, którego klucz nie ma wymaganego zakresu, zwraca 403. To różnica względem 401, który oznacza brak lub nieważny klucz. Pełna taksonomia zakresów:
Przyznawaj każdemu kluczowi tylko te zakresy, których potrzebuje. Klucz służący wyłącznie do synchronizacji subskrybentów nie potrzebuje campaigns:write ani billing:read.