HTTPS API v2 / Skrócone linki

API umożliwia wygenerowanie skróconego linku dla innego adresu URL lub ciągu danych w postaci QR Codu. Utworzony link odsyła do domeny http://otworz.to/abc123, która przekieruje użytkownika dalej. Końcówka adresu np. abc123 jest unikalnym identyfikatorem treści jaka została ukryta pod linkiem.

Tworzenie skróconego adresu

Wywołanie adresu

Aby przy pomocy zdalnej obsługi utworzyć nowy skrócony link, należy wywołać określony adres URL metodą POST.

shortlink/add

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
url	String	np. http://serwersms.pl	Adres strony WWW, do której nastąpi przekierowanie
qrcode	String	np. 123456789ABC lub http://serwersms.pl	Ciąg danych do zakodowania w postaci QR Codu. Może to być również adres URL. Dane powinny zawierać minimum 3 znaki i nie więcej niż 2000 znaków.
unique_id	String	np. abc123	Unikalny identyfikator linku, który pojawi się za adresem otworz.to (np. otworz.to/abc123). Identyfikator powinien mieścić się w zakresie 3-50 znaków. Dozwolone są litery bez polskich znaków, cyfry oraz znaki "-", "." oraz "_".

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

Zwrot odpowiedzi

{
   "link":"otworz.to/abc123",
   "counter":0,
   "meta":"SerwerSMS.pl"
}

Jeśli przesłany w parametrze adres URL okaże się błędny lub niedostępny, w odpowiedzi zwrotnej zostanie wysłany kod błędu 404.

Podgląd liczby kliknięć

Wywołanie adresu

Aby przy pomocy zdalnej obsługi podejrzeć liczbę kliknięć w link, należy wywołać określony adres URL metodą POST.

shortlink/stats

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
id	String	abc123	Identyfikator skróconego linku

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

Zwrot odpowiedzi

{
   "link":"otworz.to/abc123",
   "counter":122,
}