Dokumentacja

Dowiedz się jak w prosty sposób zintegrować Emaillabs z dowolnym narzędziem do wysyłki email korzystając z API lub Restful SMTP.

API

Dokumentacja API

Przejdź do dokumentacji API >>>

Wysyłka wiadomości e-mail

Poniższa dokumentacja jest już nieaktualna kliknij w link poniżej aby przejść do aktualnej dokumentacji. Przejdź do dokumentacji API >>> Funkcja umożliwia wysyłanie wiadomości pojedynczej lub masowej wiadomości e-mail, w zamyśle zastąpi metodę sendmail pod koniec października. Nowa metoda wysyłki wiadomości oparta jest w pełni o metodę sendmail_templates. Dzięki nowej strukturze danych umożliwia łatwy rozwój oraz […]

Wysyłka wiadomości e-mail z szablonem

Funkcja umożliwia wysyłanie wiadomości z wykorzystaniem wgranego wcześniej szablonu lub pojedyncze wysłanie szablonu bez jego zapisu. Zapytanie należy kierować na podany poniżej adres przy użyciu metody POST: Adres URL: [crayon-5f69d3b729d7c635181822/] Metoda: [crayon-5f69d3b729d82805911038/] Wywołanie: [crayon-5f69d3b729d84410532417/] Typ: [crayon-5f69d3b729d85319659790/] Struktura danych: [crayon-5f69d3b729d87277403955/] Parametry: Parametr Opis Wymagalność to Adres e-mail odbiorcy wiadomości e-mail ( w formie tablicy ) tak […]

Dodawanie szablonu wiadomości

Funkcja umożliwia dodawanie szablonu wiadomości. Zapytanie należy kierować na podany poniżej adres przy użyciu metody POST: Adres URL: [crayon-5f69d3b72a0d6604586593/] Metoda: [crayon-5f69d3b72a0db855376410/] Wywołanie: [crayon-5f69d3b72a0dc852949690/]   Parametry: htmlWiadomość w formacie HTMLtak* Parametr Opis Wymagalność text Wiadomość w formacie tekstowym tak** * – wymagane jeżeli nie występuje parametr text ** – wymagane jeżeli nie występuje parametr html, w […]

Dane zagregowane

Funkcja umożliwia pobranie danych zagregowanych z podziałem na statusy. Zapytanie należy kierować na podany poniżej adres przy użyciu metody GET: Adres URL: [crayon-5f69d3b72a3bc360486430/] Metoda: [crayon-5f69d3b72a3c1249161433/] Wywołanie: [crayon-5f69d3b72a3c3316606077/]   Parametry: Parametr Opis Wymagalność smtp_account Nazwa konta SMTP tak date_from Data od w formie timestamp tak date_to Data do w formie timestamp nie Wynik zapytania: [crayon-5f69d3b72a3c5392290059/]   […]

Dane zagregowane z podziałem na tagi

Funkcja umożliwia pobranie danych zagregowanych z podziałem na tagi. Zapytanie należy kierować na podany poniżej adres przy użyciu metody GET: Adres URL: [crayon-5f69d3b72a6a0349240059/] Metoda: [crayon-5f69d3b72a6a5436909957/] Wywołanie: [crayon-5f69d3b72a6a7070525453/]   Parametry: Parametr Opis Wymagalność smtp_account Nazwa konta SMTP tak date_from Data od w formie timestamp tak date_to Data do w formie timestamp nie Wynik zapytania: [crayon-5f69d3b72a6a9413129561/]   […]

Sprawdzanie czy adres e-mail jest tymczasowy.

Funkcja pozwala określić czy adres e-mail jest zarejestrowany w jednym z serwisów z tymczasowymi adresami e-mail ( tj. YopMail ) Adres URL: [crayon-5f69d3b72a970449368434/] Metoda: [crayon-5f69d3b72a975732348850/] Wywołanie: [crayon-5f69d3b72a977141271227/] Parametry: Parametr Opis Wymagalność adres e-mail Przekazywany bezpośrednio jako element składowy adresu url tak Wynik zapytania: [crayon-5f69d3b72a978047009433/] Zwrócone parametry: Parametr Opis code status zwrócony przez serwer w formie […]

Start z Event API

Czym jest Event API? W przeciwieństwie do Restful API, Event API wysyła dane na wskazany adres, twórca skryptu musi jedynie odebrać dane i zwrócić odpowiedni komunikat.   Jak włączyć EventAPI? Aby uruchomić usługę po pierwsze przygotuj skrypt który będzie odpowiedzialny za odbieranie danych gdy skrypt do odbioru danych jest już na miejscu, zaloguj się do […]

Start

Czym jest API? Zbiór poleceń pomagających zintegrować platformę EmailLabs z Państwa oprogramowaniem np. CRM.   Jak to działa? Platforma API obsługiwana jest w standardzie REST poprzez protokół HTTP oraz HTTPS, z wykorzystaniem metody autoryzacji Basic Auth. Rozwiązania tego typu pozwalają szybko połączyć się z EmailLabs, oraz pobrać niezbędne dane, bez konieczności logowania się do panelu […]

Wysyłka wiadomości e-mail

Poniższa dokumentacja jest już nieaktualna kliknij w link poniżej aby przejść do aktualnej dokumentacji. Przejdź do dokumentacji API >>> Funkcja umożliwia wysyłanie wiadomości. Zapytanie należy kierować na podany poniżej adres przy użyciu metody POST: Adres URL: [crayon-5f69d3b72b1c2929133043/] Metoda: [crayon-5f69d3b72b1c7805912952/] Wywołanie: [crayon-5f69d3b72b1c8843488976/]   Parametry: Parametr Opis Wymagalność to Adres e-mail odbiorcy wiadomości e-mail ( w formie […]

Pobieranie wiadomości e-mail na podstawie statusu

Funkcja pozwala pobrać wiadomości e-mail w oparciu o status jaki otrzymała ostatecznie. Umożliwia to monitorowanie adresów do których nie dociera korespondencja.   Adres URL: [crayon-5f69d3b74b812306359651/] Metoda: [crayon-5f69d3b74b819874679217/] Wywołanie: [crayon-5f69d3b74b81b931727394/] Parametry: Parametr Opis Wymagalność status Status jaki chcemy wyszukać w tabeli wiadomości ( dodawany jako część składowa adresu url )Statusy możliwe do wykorzystania: ok, softbounce, hardbounce, […]

Pobieranie kliknięć

Funkcja umożliwia pobranie ilości kliknięć w adresy url zamieszczone w wiadomości e-mail, przyjmuje ona dodatkowe parametry. Zapytanie należy wysyłać za pośrednictwem metody GET na adres podany poniżej:   Adres URL: [crayon-5f69d3b74bc7a799747816/] Metoda: [crayon-5f69d3b74bc80707148784/] Wywołanie: [crayon-5f69d3b74bc82309816258/] Parametry: Parametr Opis Wymagalność offset Numer strony tak limit Ilość rezultatów na stronę tak sort Pole po którym odbędzie się sortowanie, […]

Pobieranie otwarć wiadomości

Funkcja umożliwia pobranie otwarć wiadomości e-mail przez uzytkowników, przyjmuje ona dodatkowe parametry. Zapytanie należy wysłać metodą GET na wskazany poniżej adres.   Adres URL: [crayon-5f69d3b74c0de759445196/] Metoda: [crayon-5f69d3b74c0e3041277687/] Wywołanie: [crayon-5f69d3b74c0e5728194767/] Parametry: Parametr Opis Wymagalność offset Numer strony tak limit Ilość rezultatów na stronę tak sort Pole po którym odbędzie się sortowanie, możliwe jest sortowanie wg. pól: msgid, date, to, […]

Pobieranie statusów wiadomości wysłanych przez SMTP

Funkcja umożliwi pobranie wiadomości e-mail wysłanych przez serwer SMTP. Przyjmowane parametry pozwalają określić na podstawie jakich pól ma odbyć się wyszukiwanie, co pozwala bardzo precyzyjnie dopasować wynik. Zapytanie metodą GET należy kierować na adres zawarty w dokumentacji poniżej:   Adres URL: [crayon-5f69d3b74c4e1452409841/] Metoda: [crayon-5f69d3b74c4e6574355212/] Wywołanie: [crayon-5f69d3b74c4e8597080604/] Parametry: Parametr Opis Wymagalność offset Numer strony tak limit […]

Dodawanie adresu e-mail do czarnej listy

Funkcja pozwala dodać adres e-mail do czarnej listy, co wykluczy ten adres przy każdej kolejne wysyłce. Funkcja przyjmuje dodatkowe parametry. Zapytanie należy kierować na adres podany w dokumentacji za pośrednictwem metody POST   Adres URL: [crayon-5f69d3b74c8cb454211396/] Metoda: [crayon-5f69d3b74c8d0242577882/] Wywołanie: [crayon-5f69d3b74c8d2228129093/] Parametry: Parametr Opis Wymagalność account Nazwa konta SMTP tak email Adres e-mail który zostanie dodany […]

Usuwanie adresu z czarnej listy

Funkcja pozwala usunąć adres e-mail z czarnej listy, przyjmuje ona jeden dodatkowy parametr. Zapytanie należy kierować na adres url podany poniżej za pośrednictwem metody DELETE.   Adres URL: [crayon-5f69d3b74cca7659307112/] Metoda: [crayon-5f69d3b74ccad822865852/] Wywołanie: [crayon-5f69d3b74ccae880797029/] Parametry: Parametr Opis Wymagalność adres e-mail Przekazywany bezpośrednio jako element składowy adresu url tak Wynik zapytania: [crayon-5f69d3b74ccb0247215119/]   Zwrócone parametry: Parametr Opis […]

Pobieranie adresu e-mail z czarnej listy

Funkcja pozwala sprawdzić czy zadany adres e-mail znajduję się na czarnej liście oraz to z jakiego powodu na nią trafił. Funkcja przyjmuje dodatkowy parametr. Zapytanie należy kierować na adres url podany poniżej przy użyciu metody GET.   Adres URL: [crayon-5f69d3b74d084140213278/] Metoda: [crayon-5f69d3b74d089066079301/] Wywołanie: [crayon-5f69d3b74d08b688940801/] Parametry: Parametr Opis Wymagalność adres e-mail Przekazywany bezpośrednio jako element składowy […]

Pobieranie listy powodów odrzuceń na czarnej liście

Funkcja umożliwia pobranie listy powodów odrzuceń na czarnej liście adresów e-mail, nie przyjmuje ona dodatkowych parametrów. Zapytanie należy kierować na adres podany poniżej przy użyciu metody GET:   Adres URL: [crayon-5f69d3b74d464211017294/] Metoda: [crayon-5f69d3b74d46a775089775/] Wywołanie: [crayon-5f69d3b74d46b723132581/] Parametry: Metoda nie przyjmuje dodatkowych parametrów. Wynik zapytania: [crayon-5f69d3b74d46d716527538/]   Zwrócone parametry: Parametr Opis code status zwrócony przez serwer w […]

Pobieranie czarnej listy

Funkcja pozwala pobrać listę adresów zablokowanych ( czarną listę ) do których nie będą kierowane wiadomości e-mail, przyjmuje ona dodatkowe parametry. Zapytanie należy kierować na adres podany poniżej za pośrednictwem metody GET.   Adres URL: [crayon-5f69d3b74d845374759357/] Metoda: [crayon-5f69d3b74d84a109472467/] Wywołanie: [crayon-5f69d3b74d84c783494450/] Parametry: Parametr Opis Wymagalność offset Numer strony tak limit Ilość rezultatów na stronę tak sort […]

Pobieranie listy kont SMTP

Funkcja umożliwia pobieranie listy kont SMTP przypisanych do panelu użytkownika, nie przyjmuje ona dodatkowych parametrów. Zapytanie należy kierować metodą GET na wskazany poniżej adres.   Adres URL: [crayon-5f69d3b74dc2b540626576/] Metoda: [crayon-5f69d3b74dc31032887015/] Wywołanie: [crayon-5f69d3b74dc33417134011/] Parametry: Funkcja nie przyjmuje dodatkowych parametrów Wynik zapytania: [crayon-5f69d3b74dc34883265154/]   Zwrócone parametry: Parametr Opis code status zwrócony przez serwer w formie numerycznej status […]

Dobre praktyki

Aby ustrzec się przed  kradzieżą danych lub przejęciem kontroli nad kontami SMTP warto przestrzegać kilku prostych kroków. 1 ) Nie udostępniaj osobom trzecim hasła oraz loginu do panelu EmailLabs 2 ) Nie podawaj kluczy AppKey oraz SecretKey osobom trzecim 3 ) Jeżeli tylko to możliwe zawsze używaj protokołu HTTPS. Używanie tego połączenia zapobiega podsłuchom oraz […]

Przekazywanie własnych identyfikatorów

Poniższa dokumentacja jest już nieaktualna kliknij w link poniżej aby przejść do aktualnej dokumentacji. Przejdź do dokumentacji API >>> Identyfikatory Czyli pola w nagłówku e-mail pozwalające zidentyfikować wiadomość e-mail, np. jej pochodzenie, datę wysłania itp. Jednak tego typu pola można tworzyć i wykorzystywać samemu do przesyłania konkretnych danych. Jednym z takich pól jest pole Message-id. […]

Podgląd wiadomości na różnych urządzeniach i aplikacjach

Metoda umożliwia przegląd wiadomości na różnych urządzeniach, w różnych aplikacjach oraz sprawdzenie wiadomości przez filtry antyspamowe. Aby wykonać tą akcję należy wysłać następujące dane przy użyciu POST: Adres URL: [crayon-5f69d3b74e777496593545/] Metoda: [crayon-5f69d3b74e77c136540632/] Wywołanie: [crayon-5f69d3b74e77d905135795/]   Parametry: Parametr Opis Wymagalność smtp_account Konto SMTP przez które chcesz wysłać wiadomość tak subject Temat wiadomości ( max. 128 znaków […]

Pobieranie wyniku dla podglądu wiadomości

Metoda umożliwia pobranie wyników podglądu wiadomości e-mail. Aby wykonać tą akcję należy wysłać następujące dane przy użyciu GET: Adres URL: [crayon-5f69d3b74eb41833536570/] Metoda: [crayon-5f69d3b74eb47487709556/] Wywołanie: [crayon-5f69d3b74eb48738545050/]   Parametry: Parametr Opis Wymagalność id Identyfikator z wyniku poprzedniego zapytania „Pobieranie wyniku dla podglądu wiadomości” ) tak   Wynik zapytania: [crayon-5f69d3b74eb4a670665575/]   Zwrócone parametry: Parametr Opis code status zwrócony […]

Utwórz konto w E-mailLabs już dziś

Wysyłaj do 24 000 wiadomości e-mail miesięcznie zawsze za darmo