Interfejs do.php to nic innego jak SareScript przyjmujące żądania wykonania z zewnętrznego źródła (otwarty endpoint).
Działa on z wykorzystaniem protokołów http i https (połączenie szyfrowane). Wywołanie występuje poprzez wywołanie odpowiedniego linku w przeglądarce lub wysłania żądania z własnej aplikacji.
Aby móc korzystać z takiego endpointa należy go stworzyć w systemie Sare w sekcji SareScript->Przeglądaj->Skrypty.
Po stworzeniu nowego skryptu (przykład: skrypt o nazwie “api”), należy nadać mu interface pod którym to będzie dostępny na zewnątrz. W tym celu klikamy w zaznaczony element.
Następnie w polu wartość wpisujemy nazwę dla naszego endpointa. Będzie to nazwa pod która będzie dostępny nasz skrypt.
Aktualnie w głównym widoku skryptów widzimy, że zmienił się interface dla naszego skryptu. Możemy w niego kliknąć aby zobaczyć szczegółowe informacje.
Znajdziemy tam między innymi pełny link do naszego endpointu, możliwość zmiany nazwy lub usunięcia interface.
Endpoint przyjmuje dane przekazane przez metodę GET lub POST.
Dla metody GET możemy skorzystać z Frienldy URL lub standardowego przekazania parametrów:
np. https://s.enewsletter.pl/do/{uid}/api/param1/param2 lub https://s.enewsletter.pl/do/{uid}/api?0=param1&1=param2
Prosty przykład wyświetlania przychodzących danych znajduje się tutaj: get_request()
Inne funkcje zbierania danych dostępne są poniżej:
get_request_ip()
get_request_agent()
Warto pamiętać o zabezpieczeniu własnego skryptu DO.php, gdyż jest on ogólnie dostępny dla każdego mającego url!
Kilka przykładów wykorzystania do.php do pobrania tutaj.