Informacje dotyczące korzystania z dokumentacji API:
- Przykładowe zapytania zawarte w opisie metod wskazują na demonstracyjną wersję API i nie powinno się ich bezpośrednio kopiować. By uzyskać odpowiedni adres, pod który należy wysyłać zapytania należy przeczytać rozdział 'Informacje ogólne'.
- Metody dodające lub aktualizujące zasoby (POST, PUT) zwracają w odpowiedzi odpowiednio dane nowego lub zaktualizowanego wpisu. Metody DELETE nie zwracają niczego w ciele odpowiedzi.
Zestaw podstawowych informacji dotyczących korzystania z API.
Opis procesu autoryzacji oraz weryfikacji uprawnień użytkowników.
Obsługa błędów przez API wraz z ich pełną listą.
Dodatkowe parametry pozwalające wpłynąć na ostateczną postać odpowiedzi API.
Zasoby:
Typy zasobów obsługiwanych przez usługę API oraz opis operacji jakie na nich można wykonywać.
Domeny pocztowe:
Odczyt oraz modyfikacja ustawień domen pocztowych.
GET
Odczyt ustawień wybranej domeny pocztowej.
PUT
Modyfikacja ustawień wybranej domeny pocztowej.
Konta pocztowe:
Odczyt i modyfikacja ustawień kont pocztowych, dodawanie oraz usuwanie kont pocztowych.
GET
Lista kont pocztowych w obrębie domeny.
GET
Odczyt ustawień wybranego konta pocztowego.
POST
Utworzenie nowego konta pocztowego.
PUT
Modyfikacja ustawień jednego lub wielu kont pocztowych.
DELETE
Usunięcie jednego lub wielu kont pocztowych.
Aliasy pocztowe:
Odczyt i modyfikacja ustawień aliasów pocztowych, dodawanie oraz usuwanie aliasów pocztowych.
GET
Lista aliasów w obrębie danej domeny pocztowej.
GET
Odczyt ustawień wybranego aliasu pocztowego.
POST
Dodanie nowego aliasu pocztowego.
PUT
Modyfikacja jednego lub wielu aliasów pocztowych.
DELETE
Usunięcie jednego lub wielu aliasów pocztowych.
Listy pocztowe:
Odczyt i modyfikacja ustawień list pocztowych, dodawanie oraz usuwanie list pocztowych.
GET
Lista list pocztowych w obrębie wybranej domeny.
GET
Odczyt ustawień wybranej listy pocztowej.
POST
Dodanie nowej listy pocztowej.
PUT
Modyfikacja jednej lub wielu list pocztowych.
DELETE
Usunięcie jednej lub wielu list pocztowych.