HTTPS XML API / Tworzenie subkont

System umożliwia zdalne listowanie oraz tworzenie subkont w systemie (na które można się również zalogować z poziomu Panelu Klienta). Aby utworzyć konto, należy najpierw zdefiniować w Panelu Klienta przynajmniej jedno subkonto które później będzie użyte jako szablon uprawnień. Wszystkie ustawienia dot. np. przekazywania raportów doręczeń czy też odpowiedzi na SMS ECO+ zostaną skopiowane z szablonowego subkonta na nowego subkonto.

Listowanie subkont

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wylistować aktualne dostępne subkonta, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:

https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=subkonta&operacja=lista

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	subkonta	Wartość odpowiadająca zarządzaniu subkontami
login	String	Login	Login konta
haslo	String	Haslo	Hasło konta
operacja	String	lista	Wartość taka pozwoli wylistować subkonta

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <Subkonto id="123">zbyszek</Subkonto>
 <Subkonto id="456">login2</Subkonto>
 <Subkonto id="789">testowy</Subkonto>
</SerwerSMS>

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<Subkonto id="ID">LOGIN</Subkonto>	Parametr „ID” określa identyfikator subkonta, „LOGIN” określa login subkonta.

Tworzenie subkont

Wywołanie adresu

Aby przy pomocy zdalnej obsługi utworzyć nowe subkonto, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:

https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=subkonta&operacja=dodaj&subkonto_login=loginabc&subkonto_haslo=hasloabc&subkonto_szablon=123&subkonto_nazwa=test&subkonto_numer=500600700&subkonto_email=test%40adres.pl

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
akcja	String	subkonta	Wartość odpowiadająca zarządzaniu subkontami
login	String	Login	Login konta
haslo	String	Haslo	Hasło do konta
operacja	String	dodaj	Wartość taka pozwoli utworzyć nowe subkonto
subkonto_login	String	np. „login1”	Login nowego subkonta (3-20 znaków z zakresu (a-z, A-Z, 0-9 oraz znaki: , _ @
subkonto_haslo	String	np. „testABC”	Hasło nowego subkonta (3-20 znaków)
subkonto_szablon	Integer	np. 123	Identyfikator subkonta z którego mają zostać przeniesione uprawnienia dostępu oraz widoku
subkonto_nazwa	String	np. „testowe subkonto”	Nazwa opisująca nowe subkonto
subkonto_numer	String	np. „500600700”	Numer telefonu nowego subkonta
subkonto_email	String	np. „test@test.pl”	Adres email nowego subkonta

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:

<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
 <Subkonto>OK</Subkonto>
</SerwerSMS> 

Objaśnienie poszczególnych sekcji XML

Znacznik XML	Opis
<Subkonto>STAN</Subkonto>	Tag Subkonto zawiera informację STAN na temat status tworzenia nowego subkonta. W przypadku powodzenia, zwrócone zostanie „OK”. W przypadku wystąpienia błędu, zostanie zwrócony kod numeryczny lub opis alfanumeryczny (w zależności od ustawień API).