Dokumentacja interfejsu HTTPD. Platforma BSMS.PL Instrukcja podłączenia po przez http

Transkrypt

1 Dokumentacja interfejsu HTTPD Platforma BSMS.PL Instrukcja podłączenia po przez http

2 Dokumentacja interfejsu httpd (strona 2) SPIS TREŚCI 1. Zawartość dokumentu str.3 2. Informacje ogólne 2.1 Zastosowanie 2.2 Połączenie HTTPD Parametry połączenia Wersja HTTPD Adres URL Metoda przesyłania danych Autoryzacja Zmienne str Połączenie SSL Ograniczenia połączenia 2.3 Operacje wspierane przez interfejs Wysyłanie SMS-ów metodą GET lub POST Sprawdzanie statusów metodą GET lub POST str.8

3 Dokumentacja interfejsu, mysql (strona 3) 1.Zawartość dokumentu Dokument ten opisuje interfejs HTTPD pozwalający na połączenie z platformą bsms.pl. Jest to pierwsza wersja dokumentacji 2.Informacje ogólne Interfejs httpd to możliwość wysłania SMS-ów za pomocą protokołu http. Klient, który w swojej usłudze zaktywuje ten interfejs otrzymuje dostęp do api http, który umozliwia wysyłanie sms-ów. Podłączenie może odbyć się za pomocą dowolnej aplikacji klienckiej, czy skryptu wykorzystującego interfejs http Zastosowanie Opisany w niniejszym dokumencie, interfejs HTTPD ma zastosowanie jedynie w ramach platformy, i jest jej częścią składową. Interfejs pozwala na wysyłanie SMS-ów w ramach wspomnianej platformy i jest to jedynego jego zastosowanie w obecnej wersji Połączenie do HTTPD Połączenie do http następuje po wywołaniu URL do skrypty Parametry połączenia Niniejszy punkt zawiera istotne dla komunikacji parametry połączenia klienta z bazą danych Wersja HTTPD Wersja protokolu httpd: Adres URL Wszyscy użytkownicy łączą się z serwerem powinni wywoływać adres Metoda przesyłania danych Protokuł obsługuje metody POST oraz GET Autoryzacja Autoryzowanie wysyłki odbywa się po przesłaniu zmiennej md5 wygenerowanej na podstawie Loginu oraz Hasła.

4 Dokumentacja interfejsu httpd(strona 4) Zmienne md5 suma kontrolna połączonych zmiennych LOGIN + HASŁO przykład: md5( login. pass ); msisdn numer odbiorcy body Treść SMS-a send_after Pole nieobowiązkowe (przypadku podania tej zmiennej należy użyć daty formacie :00:00) le nie obowiązkowe (zmienna f spowoduje wysłanie sms-a typu FLASH) status Wartość true spowoduje zapytanie o status wyslanego SMS-a id ID sms-a, którego ma dotyczyć zapytanie o status 2.3 Operacje wspierane przez interfejs Interfejs HTTPD wspiera dwie podstawowe operacje: Wysyłanie SMS-ów Sprawdzanie Statusów wysłanych SMS-ów Wysyłanie SMS-ów metodą GET LUB POST Aby wysłać SMS-a metodą GET należy przygotować odpowiedni parametr: Przykład PHP: ********************************************************************************************* <? $aut['login'] = 'test'; $aut['pass'] = 'test'; $aut['url']='apisms.bsms.pl/send-sms.php'; function send_get_sms($post=false,$msisdn,$body,$send_after=null,$type_sms=null,$status=null,$id=null){ global $aut; $curl = curl_init(); if($post){ $link=(' $POST ='md5='.md5($aut['login']. $aut['pass']).'&msisdn='.$msisdn.'&body='.str_replace(' ','%20',$body).'&send_after='.$send_after.'&type_sms='.$type_sms.'&status='.$status.'&id='.$id; else{ $link=(' $aut['pass']).'&msisdn='.$msisdn.'&body='.$body.'&send_after='.$send_after.'&type_sms='.$type_sms.'&status='.$s tatus.'&id='.$id); curl_setopt($curl, CURLOPT_URL, $link); curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1); curl_setopt($curl, CURLOPT_CONNECTTIMEOUT, 2); curl_setopt($curl, CURLOPT_TIMEOUT, 5); if($post){ curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_POSTFIELDS, $POST); curl_setopt($curl, CURLOPT_FOLLOWLOCATION, false); $content = curl_exec($curl); curl_close($curl);

5 return $content; echo send_get_sms(false,' ', test );?> ********************************************************************************************** Funkcja send_get_sms może zwrócić 2 wartości. FAILED w przypadku jakiegoś błędu lub wartość numeryczną, czyli ID SMS-a. Pierwsza wartość w funkcji określa metodę wysyłki False metoda GET True metoda POST Sprawdzanie statusów metodą GET LUB POST Sprawdzenie statusu odbywa się identyczną funcją j/w opisaną wyżej echo send_get_sms(false,null,null,null,null,true, 1 ); gdzie w tym przypadku 1 to id SMS-a