Proware Cloud Webbuilder Versie 2.30

Transcriptie

1 Proware Cloud Webbuilder Versie 2.30 Laatste update:

2 Inhoudsopgave Het principe van open login... 3 Functie- en procedurebeschrijving... 5 Loginfunctie... 5 Bevestigingsfunctie... 5 Demobestanden... 6 Remote login... 7 Inleiding... 7 Stappen in het remote inlogproces... 7 Een grafische weergave van het remote loginproces Stappen na inloggen

3 Het principe van open login Loginbutton op de website van de club club>.prowaregolf.nl/openlogin?sid=<session ID>&callback= club>.prowaregolf.nl/topencallback.php&redirect=<redirect pagina> Aanvraag met sessie-id en redirect-pagina Callbackpagina (aan de clubkant) De sessie is goed bevonden: er wordt een token naar de callbackpagina gestuurd. Open login (aan de ProwareGolfkant) De sessie is onjuist en wordt doorgestuurd naar de login-pagina De sessie is alsnog goed bevonden: er wordt een token naar de callback-pagina gestuurd. Inlogpagina (aan de ProwareGolfkant) Token wordt teruggestuurd naar de open login-pagina. Open login (aan de ProwareGolfkant) Redirectpagina (aan de clubkant) Token is correct: de redirect-pagina wordt weergegeven. Op de clientwebsite wordt een sessie-id gecreëerd. Deze moet samen met de redirectpagina worden meegegeven aan de applicatie (open login). 3

4 Dit sessie-id wordt aan de kant van ProwareGolf gevalideerd. Wanneer de sessie-id aanwezig is, wordt er een token aangemaakt en verstuurd naar de callback-pagina. Deze callback-pagina stuurt het token terug naar de applicatie (open login). Als dit token correct is, wordt de gevraagde redirect-pagina weergegeven. Wanneer de sessie-id niet aanwezig is, wordt de inlogpagina weergegeven. Nadat er ingelogd is, wordt alsnog de redirect-pagina weergegeven. Als demo is er op demo.prowaregolf.nl een demo-omgeving opgenomen. De link naar deze site is: Wanneer de sessie is gevonden, wordt de redirect-pagina weergegeven. De sessie is niet gevonden: het inlogscherm wordt weergegeven. Na juiste inlog wordt de redirect-pagina weergegeven. De sessie in de applicatie blijft bestaan. De clientwebsite wordt uitgelegd. Met behulp van de link komt u terecht op een webpagina, waarop een uitleg staat over het ophalen van wedstrijdinformatie en een eigen loginbox. 4

5 Functie- en procedurebeschrijving Interface voor het valideren van externe sites gebaseerd op een geldig login aan de zijde van de ProwareGolf webapplicatie. De externe site moet hiervoor een acceptatie- of bevestigingspagina hosten voor aanvragen vanaf de ProwareGolf webapplicatie. Voorbeeld: de externe site naam is %Target%, de validatie sitenaam is %Main%. Loginfunctie URL: Parameters: SID - de sessie-id van de targetsite CALLBACK - de pagina voor het ontvangen van de respons van de mainsite REDIRECT - niet vereist, voor het redirecten van de targetsite wanneer de login gevalideerd is Omschrijving: Targetsite kan een redirect maken naar de mainsite, bijvoorbeeld &redirect=/user/ zal de callback redirecten wanneer de login gevalideerd is Bij een valide login worden drie parameters geretourneerd; de SID, de REDIRECT en een TOKEN, bijvoorbeeld: Bevestigingsfunctie URL: Methode: POST Parameters: SID - de sessie-id van de targetsite CALLBACK - de pagina voor het ontvangen van de respons van de mainsite TOKEN - de ontvangen token uit de login RESPONSE - SUCCESS of FAILED Omschrijving: Nadat de targetsite de token heeft ontvangen kan de targetsite deze token gebruiken om te valideren. De token is eenmalig en zal bij iedere validatie opnieuw moeten worden aangevraagd. 5

6 Demobestanden Volgende bestanden zijn voor demodoeleinden: tpages.php tdemologin1.php topencallback.php tpages.php Dit is een voorbeeld van een beveiligd bestand. Wanneer de huidige gebruiker niet is ingelogd (wij gebruiken in dit voorbeeld check _SESSION[ remotelogged ] functie ) dan wordt de pagina geredirect naar tdemologin1.php, anders wordt de pagina getoond. tdemologin1.php Dit is een voorbeeld om gebruik te maken van pagina voor het valideren van de huidige browsersessie. Klik op de link en de pagina wordt geredirect naar het bovenstaande adres. Sid is het huidige sessie-id en callback is en de redirect is naar /tpages.php. topencallback.php Nadat de huidige loginstatus heeft gecontroleerd, wordt naar de redirect-pagina geredirect. Hierna kan met de sid, de redirect en de token de pagina worden aangeroepen. Hier wordt de token gevalideerd en wanneer het resultaat SUCCES is, dan kan de membersessie worden geüpdatet, bijvoorbeeld _SESSION[ remotelogged ] = true en kan worden geredirect naar tpages.php en anders naar tdemologin1.php?message=invalid 6

7 Remote login Inleiding ProwareGolf biedt een service aan voor het remote inloggen van een applicatie bij NGP. Deze service bevindt zich op het moment van schrijven op het domein Deze URL kan in de toekomst veranderen. Deze documentatie is gericht op developers. De voorbeeldcode is bedoeld als richtlijn, niet als werkende implementatie. De voorbeeldcode is geschreven in C#, maar de principes zijn ook van toepassing op andere talen zoals PHP en Java. Stappen in het remote inlogproces Het remote inloggen bij NGP gebeurt door twee requests naar ProwareGolf te versturen. Met het eerste request wordt geauthenticeerd. Met het tweede request wordt het authenticatietoken dat verkregen wordt, via de authenticatie nog eens gevalideerd. 1. De gebruiker logt in via een loginbox op de applicatie (in de meeste gevallen is dit een website van een golfvereniging). De loginbox POST naar een URL op de applicatie. 2. Een back-end script (PHP, C#, Java, etc.) op deze URL, leest de gebruikersnaam en het wachtwoord uit en begint met het opbouwen van een POST-request. Deze zal straks naar een URL van ProwareGolf verstuurd worden. 3. REQUEST 1: AUTHENTICATIE Dit POST-request gaat naar de URL en bevat de volgende gegevens. a. Een SID een zelf gegenereerde code (verplicht) b. Een CALLBACK URL een URL op de lokale applicatie. Dit is waar ProwareGolf straks zelf een request naartoe gaat sturen. Je kunt dezelfde URL gebruiken van het script dat de POST van het loginformulier opvangt. Dan doe je alles dus in één script. (verplicht) c. Een REDIRECT voor het redirecten van de applicatie als er gevalideerd is (optioneel). d. De username en het wachtwoord als POST variabelen (verplicht) In C# zou het opbouwen en afvuren van de login request eruit kunnen zien zoals hieronder. De code verschilt natuurlijk per taal. Het belangrijkste zijn dan ook de parameters in de url (callback en sid) en de payload van de post request (username en password). De URL waarnaar je post, ziet er ongeveer zo uit: ID?callback= 7

8 4. REQUEST 2: VALIDATIE Als de authenticatie aan de kant van ProwareGolf slaagt, dan stuurt ProwareGolf een request terug naar de callback-url die je hebt opgegeven. Deze vang je op en je leest het meegestuurde token en sid uit. Met deze gegevens stuur je weer een POSTrequest terug naar ProwareGolf, maar dit maal ter validatie naar de URL. De volgende gegevens moeten meegestuurd worden. a. sid: de sessie-id (verplicht) b. callback: de callback-url (verplicht) c. token: de ontvangen token uit de eerste login request (verplicht) In C# zou een URL er zo uit kunnen zien: REERDESSID?callback= 8

9 5. Als de respons van het validatierequest SUCCESS is, dan ben je ingelogd aan de kant van ProwareGolf. 9

10 Een grafische weergave van het remote loginproces Stappen na inloggen De stappen na remote inloggen hangen af van je wensen. Je kunt de remote login van ProwareGolf als authenticatiemechanisme gebruiken voor je eigen (golf)site. Je kunt dan, als er SUCCESS ontvangen is, de gebruikers inloggen op de site. Na het remote inloggen is de gebruiker in elk geval ingelogd bij ProwareGolf. Dat betekent dat er aan de kant van ProwareGolf een sessie bestaat voor deze gebruiker. De gebruiker kan naar ProwareGolf NGP geleid worden en is direct ingelogd bij NGP. 10