Interfejs RestAPI pozwala na automatyzację procesu wysyłki SMS, sprawdzania statusu wysłanych SMS-ów, odbierania SMS-ów oraz umożliwia wprowadzenie cykliczności do obu wymienionych zadań.
Interfejs został oparty na technologii HTTPS, a dane przekazywane są w formacie JSON. W zależności od wywoływanej funkcji wykorzystywane są następujące metody protokołu HTTP: POST, PUT oraz GET.
Możliwość wykorzystania interfejsu mają wszyscy klienci serwisu SMeSKom z przynajmniej jedną, działającą usługą. Usługa w serwisie SMeSKom identyfikowana jest poprzez dane autentykacyjne (login i hasło) podane w panelu sterowania serwisu SMeSKom. Dzięki tym danym system wie, za pomocą której usługi ma wysyłać i odbierać SMS-y.
# Wersja z basic auth
curl -i -H "Content-type: application/json" \
-u htguser9999:XXXXXXXXX -X POST \
https://api1.smeskom.pl/api/v1/sms/send \
-d '{"msisdn":"501100100","body":"tresc sms"}'
# Wersja z login/password w parametrach
curl -i -H "Content-type: application/json" \
-X POST https://api1.smeskom.pl/api/v1/sms/send \
-d '{"login":"htguser9999","password":"XXXXXXXX”, \
"msisdn":"501100100","body":"tresc sms"}'
require ‘json’
uri = URI("https://api1.smeskom.pl")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new("/api/v1/sms/send", initheader = {'Content-Type' =>'application/json'})
request.basic_auth("htguser99999", "XXXXXXXXXXX")
payload={
"msisdn" => "500100100",
"body" => "Zażółć gęślą jaźń"
}
request.body=payload.to_json
http.start
response = http.request(request)