Interaction sequence

As user wants to log on web site with Medpass authentication, he has to pass his Medpass login account. This login should be represented as unique login part and the openID server part. It is better to request from user just login but before sending it to server, it should be changed to full version that includes server address in it, for example: http://jkowalski.medpass.pl. Then, the web site redirects the browser to the medpass.pl, where the user can authenticate himself against the OpenID provider. After successful authentication, either with a traditional method (username and password) or with more advanced techniques (such as certificate exchange), the OpenID provider redirects the browser back to the originating web site, along with the verified user credentials.

Working with OpenID
It is important to select an OpenID compliant library compatible with you programming language. There are libraries available for Java, Python, PHP, and others. Medpass authentication has been tested against the OpenID for Rails, PHP and .NET library. For some more libraries check:

• http://www.janrain.com/openid-enabled
• http://wiki.openid.net/Libraries
• http://code.google.com/p/openid4java/wiki/QuickStart – for java

For the user, on the third-party web site, there is only basic login form with login input text-field and submit button. All the rest is done on the safe Medpass server side, which returns the status dependent on the result of logging process.

Pic. Example of login form
When an error occurs, status is set to ‘failure’. When user is authenticated successfully and redirected to the starting page (or application) from OpenID provider, there is identity and status ‘success’ returned. This identity can be used to recognize user and open new session for him. The privileges should be set based on the session.
Logging out is done on the third-party application side by closing session of the user.
It is recommended to handle the errors with some information for the user. Usually the text displayed on the screen that something has gone wrong is good enough.
Here are some working opened implementations for different programming environments. Based on data-flow in them, system Medpass can be easily adapted to any other programming language.
PHP – http://medpass.pl/medpass_login_php.zip
Rails – http://medpass.pl/medpass_login_rails.zip
.NET – http://medpass.pl/medpass_login_asp_net.zip
What do we expect from third-party web developers to be localized by the login form?
Links to:
- Password recovery procedure: http://medpass.pl/profile/forgot_password
- Registration procedure: http://medpass.pl/medpass/register
- Information about Medpass: http://medpass.pl/article/medPassLekarze
- Medpass regulations: http://medpass.pl/medpass/eula

Contact to operating personnel (help desk):
Activeweb Sp. z o.o.
3/2 Bronikowskiego st.
02-796 Warszaw
biuro@activeweb.pl
tel. +48 (22) 894 06 33
fax +48 (22) 894 66 22

Pic. Example of handling error
• http://openid.net/specs/openid-authentication-2_0.html
• http://openid.net/specs/openid-attribute-exchange-1_0.html

Working with Medpass API
Medpass is not only OpenID server. It offers also a SOAP based webservice with a lot of methods returning data about the users registered on Medpass. After authentication, there is user’s identity returned. It can be used as one of the arguments to receive information about that user.
SOAP webservice is safe and has its own security system. For more information please contact our company.

Some examples of the methods:

getUserBulletins 

Returns bulletins, which user is signed up for.

Parameters: 

- openid_url

Returns: 

- String build of firstname, firstname and lastname, login or phrase for anonymous users.

example:

<?xml version="1.0" encoding="UTF-8" ?>
<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:env=http://schemas.xmlsoap.org/soap/envelope/
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<env:Body>
<n1:GetBulletinsResponse xmlns:n1="urn:ActionWebService"

env:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<return n2:arrayType="n1:BulletinSoap[53]"

xmlns:n2=http://schemas.xmlsoap.org/soap/encoding/
xsi:type="n2:Array">

<item>

<name xsi:type="xsd:string">Poradnik Medyczny</name>
<b_id xsi:type="xsd:int">1</b_id>
<link xsi:type="xsd:string">http://poradnikmedyczny.pl</link>

</item>

</return>

</n1:GetBulletinsResponse>

</env:Body>

</env:Envelope>

getDesiredName 

Returns name of the user in accordance with the private policy.
 

Parameters: 

- openid_url

Returns: 

- String build of firstname, firstname and lastname, login or phrase for anonymous users.

example: "Jan Kowalski"
"anonimowy użytkownik"

userGetGroup

Returns group (by id) of the user (is he doctor or maybe medical student?).

Parameters: 

- openid_url

Returns: 

- Integer – Id of user’s group set in Medpass 2.0.

example:

2 #doctor
5 #Phamacist

userIsDoctor 

Returns answer (true or false) for question if user is a doctor.

Parameters: 

- openid_url

Returns: 

- Boolean

example:

True # is a doctor
False # is not a doctor

For more methods, further information and implementation details please contact our company.

Oto najważniejsze zmiany:

1. Zapamiętaj mnie!

Jeśli często odwiedzasz nasze portale często, równie często musisz podawać swoje hasło aby zalogować się na stronę. Od teraz – przy logowaniu – istnieje dodatkowa opcja: „Zapamiętaj mnie na 14 dni„.  Jak sama nazwa wskazuje system zapamięta hasło dla Twojego loginu przez 14 kolejnych dni co znacznie przyśpieszy logowanie.

2. Wyślij szybko informację

Nowy system wiadomości pozwala na wysłanie informacji do Twoich znajomych w Medpass w bardzo prosty sposób,  a w dodatku możesz wysłać tę samą informacje do wielu osób. Panel do wysyłania wiadomości wyświetli się zaraz po zalogowaniu na portalu Medpass.pl

3. Profil publiczny – Twoja wizytówka w sieci

Uzupełniając swój profil w Medpass automatycznie generowana jest Twoja „wizytówka” w sieci czyli profil publiczny. Adres do Twojej wizytówki to http://www.medpass.pl/nasz-login-medpass. Teraz możemy dodatkowo uzupełnić profil o informacje o sobie oraz biografię. W opcjach prywatności możemy zaznaczyć, które informacje powinny się pokazać w profilu publicznym, a które chcemy zachować dla siebie.

Źródło: http://www.medpass.pl/pawel.jurczynski

Czekamy na Wasze uwagi i sugestie dotyczące Medpass.

Dostałeś wiadomość!

Od kilku miesięcy w systemie Medpass 2.5 dostępna jest możliwość wysyłania i odbierania wiadomości pomiędzy zarejestrowanymi użytkownikami. Wiadomości można wysyłać do każdego użytkownika Medpass, który zaakceptował nas w gronie swoich znajomych. Jeśli chcesz o każdej nowej wiadomości zostaniesz powiadomiony e-mailowo.

Znajdź swoich znajomych

Aby dodać znajomego do swojej książki adresowej możemy skorzystać z wyszukiwarki, która wyszukuje osoby po imieniu, nazwisku oraz loginie Medpass (Uwaga: w opcjach profilu publicznego istnieje możliwość ukrycia swoich danych w wyszukiwarce). Po wyszukaniu interesującej nas osoby wchodzimy w „Dodaj”. Osoba, którą dodajemy do naszych znajomych musi przyjąć zaproszenie do kontaktu, inaczej wysyłanie wiadomości do tej osoby będzie nadal niemożliwe.

Uzupełnij swój profil

Teraz masz możliwość dodania swojego zdjęcia oraz uzupełnienie swoich danych w swoim profilu. Nad wszystkim co widoczne jest w Twoim profilu publicznym masz zupełną kontrolę. Pewne informację możesz zachować tylko dla siebie.

Dodając adres miejsca pracy system automatycznie umiejscowi lokalizacje na mapie tak aby każdy zainteresowany mógł łatwo do Ciebie trafić. Masz kilka miejsc pracy? Nie ma problemu. System pozwala na dodania dowolnej ilości miejsc pracy.

Jeśli jesteś lekarzem i posiadasz specjalizacje – ważne aby zaznaczyć odpowiednie opcje w zakładce
Profil > Dane o specjalizacji. Aktualny i zgodny z prawdą profil to większa szansa na jeszcze lepsze przygotowanie dla Ciebie odpowiedniej treści na portalach medycznych wykorzystujących system Medpass, których jest już ponad 30.

W celu zapoznania się ze szczegółami procesu instalacji oraz standardem OpenID zapraszamy na stronę: medpass.pl/article/medPassPublishing.

Poniższy zestaw funkcji Medpass API umożliwia bezpieczną wymianę informacji między zewnętrznymi aplikacjami lub stronami a systemem Medpass.

Profil

exportProfile

exportProfile(api_key, openid_url) : ExportedProfile Object

Metoda zwraca dane na temat profile uzyrkownika w postaci obiektu typu:

ExportedProfile{
:user_id, :integer //id usera w medpassie
:firstname, :string // imie
:lastname, :string //nazwisko
:email, :string // email
:phone, :string // telefon
:mobile_phone, :string // komórka
:speciality, :string // specjalizacja
:birthday, :date // data urodzin
:nameday, :date // data imienin
:city, :string // miasto
:province, :string // wojewodztwo
:gender, :integer // plec
:gadu, :string // nr gg
:skype, :string // login skype
}

Argumenty:

1.api_key : String → unika unikalny ciąg znaków służący do weryfikacji
2.openid_url : String → openid_url danego użytkownika medpass (login)

user_specialties

user_specialties(api_key, login): String

Metoda zwracająca specjalizaje danego usera odzielone przecinkami w postaci ciagu znaków

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.login :String -> login usera medpassu , dla którego będziemy wyszukiwać specjalizacji

search_user

search_user(api_key, phrase, page=nil, per_page=nil) MedpassUser Array[:Object]

Metoda zwracająca tablicę User-ów którzy odpowiadali podanej frazie wyszukiwania

Argumenty:

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.phrase :String -> zmienna identyfikująca po jakim ciągu znaków będziemy wyszukiwać user-ów
3.page :String -> zmienna informująca numer strony w paginacji
4.per_page :String -> zmienna przechowująca liczbę z wilkością tablicy jaka zostanie zwrócona

Pobieranie nazwy użytkownika

getDesiredName

getDesiredName(api_key, openid_url) : String

Zwraca nazwe użytkownika zgodnie z ustawieniami profilu użytkownika (login, imie nazwisko ,etc )

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego
2. openid_url : String → openid_url danego użytkownika medpass (login)

Wiadomości medpass

WebMessage

WebMessage {
:id,         :integer //id
:sender,     :string  // nadawca (login)
:recipient,  :string // odbiorca (login)
:subject,    :string // temat
:created_at, :date // data utworzenia
:read,       :integer // czy przeczytane 1- tak 0- nie
:answered,   :integer // czy odpowiedziane 1 tak 0 nie
:deleted,    :integer // czy skasowane 1 tak 0 nie
:type_id,    :integer // id typu wiadomości
:body,       :text // treść
:short,      :integer // ??
}

messageList

messageList(api_key, openid_url, start, count, app) : WebMessage Array[Objects]

Metoda zwraca tablicę wiadomości przychodzących danego użytkownika

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. start : Integer → index wiadomości od której zacząc pobieranie (przydatne do stronicowania)
4. count : Integer → ilość wiadomości do pobrania zaczynając od indenu start (przydatne do stronicowania – ilość wiadomości na strone)
5. app : String → nazwa portalu, z którego pobrać wiadomości, np. Science, Medpass, etc

Uwaga: argumenty start i count mogą pozostac puste – wtedy ściągane są wszystkie wiadomości
Argument app pozostawiony pusty powoduje ściągnięcie wiadomości medpass ze wszystkich portali.

sentMessageList

sentMessageList(api_key, openid_url, start, count) : WebMessage Array[Objects]

Zwraca tablice wiadomosci wysłanych przez użytkonika (reszta działania analogiczna do messageList)

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. start : Integer → index wiadomości od której zacząc pobieranie (przydatne do stronicowania)
4. count : Integer → ilość wiadomości do pobrania zaczynając od indenu start (przydatne do stronicowania – ilość wiadomości na strone)

messageGet

messageGet(api_key, message_id) :WebMessage Object

Zwraca pojedyncza wiadomość o podanym id

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. message_id : Integer → id wiadomości

messageDelete

messageDelete(api_key, message_id) : Boolean

Usuwa dana wiadomość (zwraca true gdy sukces, w przeciwnym razie false)

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. message_id : Integer → id wiadomości

messageSentDelete

messageSentDelete(api_key, message_id) :Boolean

Ustawia wiadomość jako wysłaną i skasowaną

Argumenty

1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. message_id : Integer → id wiadomości

messageSend

messageSend(api_key, from, to, subject, body, app) : Boolean

Wysyła wiadomość do użytkownika (zwraca true jesli sukces , w przeciwnym razie false)

Argumenty
1. api_key : String → unikalny ciąg znaków służący do weryfikacji
2. from : String → login nadawcy
3. to : String → login odbiorcy
4. subject : String → temat wiadomości
5. body : String →treść wiadomości
6. app : String →nazwa portalu np Science

messageReply

messageReply(api_key, :from, :to, :subject, :body, app) : Boolean

Analogiczne do messsageSend

messageCount

messageCount(api_key, openid_url, type_id) : integer

Zwraca liczbe wiadomosci podanego typu. Jesli nie podano typu zwraca liczbe wszystkich wiadomosci.

Argumenty:

1. api_key : String → unika unikalny ciąg znaków służący do weryfikacji
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. type_id : Integer → id typu wiadomości

messageCountUnread

messageCountUnread(api_key, imei, type_id) : Integer

Zwraca liczbe nieprzeczytanych wiadomości (analogicznei do messageCount)

Argumenty:

1. api_key : String → unika unikalny ciąg znaków służący do weryfikacji
2. openid_url : String → openid_url danego użytkownika medpass (login)
3. type_id : Integer → id typu wiadomości

contacts_list

contacts_list( api_key, openid_url ): Array[:String]

Metoda zwracająca tablicę kontaktów danego użytwkonika w postaci ich loginów.

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.openid_url :String -> open id usera medpassu lub jego login

contacts_add

contacts_add( api_key, openid_url, target_openid_url ): Boolean

Metoda dodająca nowego uzytwkonika do listy kontaktów danego uzytkownika.

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.openid_url :String -> open id usera medpassu lub jego login
3.target_openid_url :String -> open id usera medpassu lub jego login, którego chcemy dodać do kontaktu

user_exists

user_exists( api_key, openid_url ) : Boolean

Metoda sprawdzająca czy dany użytkownik istnieje w medpasie.

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.openid_url :String -> open id usera medpassu lub jego login

Miejsca pracy

getUserCompanies

getUserCompanies(api_key, openid_url) : UserCompanySoap Array[Objects]

Metoda zwraca tablicę obiektów typu

UserCompanySoap {
medpass_id : Integer
place_id, : Integer
name : String
position : String
}

Gdzie:

medpass_id – id rekordu w baize medpass oznaczającego wpis w tabeli user_companies dla danego zakładu pracy i usera (tabela łącząca)
place_id – id miejscowości w jakiej znajduje sie zakład pracy (tabela places)
name – nazwa zakładu pracy
position – nazwa zajmowanego stanowiska

Argumenty:

1. api_key : String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2. openid_url : String → openid_url danego użytkownika medpass (login)

field_get

field_get( api_key, user, field ): String

Metoda zwracająca wartość atrybutu danego użytkownika

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.user :String -> open id usera medpassu lub jego login
3.field :String -> zmienna identyfikująca pobieraną wartość danego atrybutu użytkownika.

user_is_doctor

user_is_doctor( api_key, user ): Boolean

Metoda sprawdzająca czy dany użytkownik jest doktorem. Zwraca true jeżel jest w przeciwnym razie false

1.api_key :String → unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.user :String -> open id usera medpassu lub jego login

userGetGroup

userGetGroup( api_key, user ): Integer

Metoda zwracająca id grupy do której należy dany użytkownik .

1.api_key :String -> unikalny ciąg znaków służący do weryfikacji wywołującego metodę.
2.user :String -> open id usera medpassu lub jego login