Instrukcja techniczna implementacji ProfitSMS.pl

INSTRUKCJA TECHNICZNA
IMPLEMENTACJI PROFITSMS Z
APLIKACJAMI ZEWNĘTRZNYMI
SPIS TREŚCI
Wstęp …………………………………………………………………………..................2
I.SPRAWDZENIE POPRAWNOŚCI KODU SMS………………………………….3
1. Wersja podstawowa………………………………………………………………... 3
Tabela 1 (podstawowe parametry) ……………………………………….... 4
Tabela 2 (dodatkowe parametry) ……………………………………………. 4
II.TRYB TESTOWY……………………………………………………………...............5
III.PRZYKŁADOWE SKRYPTY …………………………………………………….......6
1
Wstęp
Niniejszy dokument przedstawia możliwości systemu API profitsms
który jest przeznaczony dla aplikacji klienckich.
W dokumencie zastosowano następujące oznaczenia:
Klient – osoba dokonująca wysyłki sms na rzecz operatora serwisu za
pośrednictwem profitsms.pl
Sprzedawca – użytkownik serwisu profitsms.pl, właściciel portalu,
sklepu internetowego, strony internetowej na której rozpoczyna się
proces walidacji.
parametr = wartość – kod źródłowy, plik przekazujący parametry do
profitsms.pl w celu walidacji wprowadzonych danych.
2
I.SPRAWDZENIE POPRAWNOŚCI KODU SMS
W API profitsms.pl dostępna jest metoda walidacyjna, dzięki której
Sprzedawcy będą mogli walidować kody wpisane przez Klientów i na
tej podstawie udostępniać im usługi.
I.1 Wersja podstawowa
W wersji podstawowej Sprzedawcy o określonym kluczu API który
jest wygenerowany automatycznie po rejestracji w serwisie
profitsms.pl, i jest dostępny w zakładce
http://profitsms.pl/podstrona/14/profil-uzytkownika/moje-uslugi.html
będą mogli zintegrować swój serwis z API profitsms.pl, który w
sposób nie widoczny dla Klienta będzie miał możliwość walidacji kodu
sms wpisanego do formularza.
Aplikacja Sprzedawcy może sprawdzić na dwa sposoby poprawność
kodu wpisanego przez Klienta wysłanego w formularzu za pomocą
metody GET lub POST
Przykładowy URL z podstawowymi parametrami:
http://profitsms.pl/check.php?apiKey=dc6985df179d87619be507a
ef8afa75a&code=ae7737db
Zbiór podstawowych parametrów przesłanych do serwisu
profitsms.pl został przedstawiony w Tabeli nr 1.
3
TABELA 1. (PODSTAWOWE PARAMETRY)
Parametr
apiKey
code
Opis
Identyfikator klienta w
systemie profitsms
Kod SMS wysłany w
formularzu
Poniżej przedstawiono Tabelę + przykład url z dodatkowymi
parametrami, które przesłane wraz z podstawowymi parametrami z
Tabeli 1 zwiększą możliwości systemu.
Przykładowy URL z dodatkowymi parametrami:
http://profitsms.pl/check.php?apiKey=dc6985df179d87619be507a
ef8afa75a&code=ae7737db&smsNr=9055
TABELA 2. (DODATKOWE PARAMETRY)
Parametr
smsNr
Opis
Parametr definiuje numer
sms na jaki został wysłany
kod. Listę numerów sms
możemy znaleźć w
dodawaniu/edycji usług
profitsms.pl
4
II. TRYB TESTOWY
Każdą integrację można wytestować generując testowe SMS w
aplikacji która znajduje się pod adresem:
http://profitsms.pl/podstrona/20/profil-uzytkownika/wyslij-testowe-smsy.html
Generowane kody są jednorazowe.
5
III. PRZYKŁADOWY SKRYPT
Poniżej znajduje się przykładowy skrypt integrujący serwis
Sprzedawcy za pomocą systemu profitsms.pl
<form action=”” method=”post”>
<input type=”text” name=”smsCode” value=”” />
<input type=”submit” name=”ok” value=”Sprawdź kod” />
</form>
<?php
if(isset($_POST[‘ok’])) {
$handle =
fopen(‘http://profitsms.pl/check.php?apiKey=dc6985df179d87619be50
7aef8afa75a&code=’.$_POST[‘smsCode’],’r’);
$status = fgets($handle,8);
fclose($handle);
switch($status) {
case 1:
// kod prawidłowy
break;
case 0:
//kod nieprawidłowy
break;
}
}
?>
6