Documentatie LiveMaster integratie Snel en gemakkelijk Liveshow voor jouw bezoekers Pagina: 1
Inleiding Wilt u de performers van LiveMaster aanbieden aan uw bezoekers, volg dan de stappen in deze handleiding om LiveMaster in uw programma te implementeren. In deze handleiding gaan wij er van uit dat u kennis heeft van databases, XML en een programmeertaal (PHP / ASP(x) of een andere vergelijkbare taal). Deze handleiding bevat de volgende stappen: 1. Het maken van de performer database 3 2. Het synchroniseren van de performergegevens 4 3. Het synchroniseren van de performerstatus 4 4. Het aanpassen van uw gebruikerstabel 5 5. Het maken van de communicatie URL 5 6. De communicatie-url argumenten 6 7. Design van de applicatie wijzigen 7 Loggen met de communicatie-url 12 De LiveMasterapplicatie is zeer eenvoudig in gebruik. U stuurt de bezoeker naar de applicatie en de applicatie controleert vervolgens bij u of de bezoeker toegang mag hebben. Geeft u TRUE aan, dan zullen wij de camapplicatie starten. LiveMaster blijft vervolgens bij u controleren of de bezoeker nog toegang mag hebben. Geeft u bij de controle FALSE terug, dan wordt de toegang beëindigd. Vanaf het moment dat het eerste signaal bij de bezoeker terecht is gekomen tot aan het moment dat u FALSE teruggeeft zullen wij de kosten voor het gebruik in rekening brengen. Het is voor LiveMaster niet van belang welk bedrag de bezoeker aan u betaalt. Of u nu 10 eurocent of u 1 euro per minuut rekent, de kosten voor het gebruik van LiveMaster blijven altijd 0,25 per verbruikte minuut. Er wordt gefactureerd op basis van de start- en stoptijd van de LiveMastersessies. U dient er derhalve voor te zorgen dat alle sessies netjes worden gesloten. Rekenvoorbeeld U heeft een bezoeker die 10 minuten betaalt a 0,80 cent. Dit levert u in dit voorbeeld 0,56 cent / minuut op. Voor deze sessie ontvangt u van uw Payment Service Provider 10 minuten * 0,56 = 5,60 Uw bezoeker kijkt in deze betaalsessie 7 minuten naar een of meerdere performers: 7 * 0,25 = 1,75 U heeft dus aan uw bezoeker verdiend: 5,60-1,75 = 3,85 Werkt u met externe promotors, dan kunt u deze dus maximaal 0,385 cent per minuut betalen. Handig om te weten: gemiddelde percentage betaling/verbruik is 71% *(gegevens t/m 31 januari 2009) Pagina: 2
1. Het maken van de performer database De performerdatabase bevat alle gegevens van de performers. De uiterlijke kenmerken, statussen en scores. Uit deze tabel kunt u later zelf uw eigen websites bouwen. Variabele Uitleg Type Lengte Id Het unieke performerid (Key) Integer 11 Nickname De naam van de performer Varchar 255 Status Tekstuele status weergave Varchar 255 Sexe Geslacht: m = man / v = vrouw / s = shemale) Varchar 1 Age Leeftijd in jaren Int 11 Birthdate Geboortedatum (YYYY-MM-DD) Date Language Talen, komma gescheiden, ISO landnamen Varchar 255 Description Omschrijving van de performer Text Fantasy Seksuele fantasie Text Sexpref Seksuele voorkeur (hetero / gay / bisexueel) Varchar 32 Looks Uiterlijk (europees, oosters, latina, etc) Varchar 32 Length Lengte van de performer Varchar 32 Weight Gewicht van de performer Varchar 32 Haircolor Kleur van het haar Varchar 32 Tattoo De locatie van eventuele tatoeages (komma gescheiden) Text 255 Eyecolor Kleur van de ogen Varchar 32 Piercing De locatie van eventuele piercings (komma gescheiden) Text 255 Operations Wat de performer seksueel doet (komma gescheiden) Text 255 Stature Lichaamsbouw Text 32 Cupsize Borstmaat Varchar 32 Photo_count Aantal foto s in de membersarea Int 11 Movie_count Aantal filmbestanden in de membersarea Int 11 Photourl URL van de afbeelding van de performer (laatste screenshot) Varchar 64 Country Land van herkomst (ISO landcode) Varchar 2 Provincy Provincie van herkost van de performer Varchar 32 Cam1 Indien webcam 1 actief is (0 = nee / 1 = ja) Int 1 Cam2 Indien webcam 2 actief is (0 = nee / 1 = ja) Int 1 Sound Indien geluid actief is (0 = nee / 1 = ja) Int 1 Score Score die LiveMaster aan de performer geeft Decimal 6,4 Flv_movies De actieve FLV bestanden voor teasers (komma gescheiden) Text 255 http://photo1.webcams.nl/1/#performerid#/#nr#.jpg http://photo1.webcams.nl/1/#performerid#/#nr#.flv Photo_galleries De actieve mappen van de foto bestanden (komma gescheiden) http://galleries.camz.nl/pics/#performerid#/#mapnr#/#image#.jpg Voorbeeld: http://galleries.camz.nl/pics/29583/32/2.jpg waarbij het image ID 1 tot 10 is. Voor de kleine foto plaatst u t achter het foto nummer. Text 255 Pagina: 3
Cam_status 0 = niet online / 1 = wel online Int 1 Sms_status 0 = Niet online / 1 = wel online Int 1 Bel_status 0 = niet beschikbaar / 1 = wel beschikbaar Int 1 2. Het synchroniseren van de performergegevens De performertabel moet nu worden gevuld. Dit vindt plaats door het aanroepen van een XML-file met performerdata op de LiveMaster.nl server. De locatie van deze XML-file is: http://www.livemaster.nl/api/performers/get_details.php Wij raden u aan deze XML-file ongeveer 1 keer per uur te synchroniseren met uw database. 3. Het synchroniseren van de performerstatus Nu de performertabel is gevuld met de meest recente data, kan de status van de performer worden uitgelezen. Hiervoor roept u wederom een XML-file aan op onze server. Deze file bevat alleen de performers die op het moment van uitlezen online zijn. Performers die niet in de file voorkomen zijn offline. De inhoud van de file is: Performer_id Het unieke ID van de performer (ID in uw Int 11 performer tabel) Status* 1 = wel online / anders = niet online Int 1 Start_time De tijd van de laatst gestarte sessie Datetime YYYY-MM-DD HH:ii:ss De locatie van deze XML-file is: CAMMEN: http://www.livemaster.nl/api/cam/get_status.php BELLEN: http://www.livemaster.nl/api/sms/get_status.php SMSEN: http://www.livemaster.nl/api/call/get_status.php Wij raden u aan dit XML bestand ongeveer 1 keer per minuut te synchroniseren met uw database. Let op, enkel performers met status 1 zijn online. Alle overige statussen worden getoond op uw pagina als NIET online. * U heeft nu een volledige performerdatabase, met performers die online zijn. U kunt nu starten met het bouwen van uw eigen webcampagina(s) op basis van de in uw database aanwezige gegevens. Pagina: 4
4. Het aanpassen van uw gebruikerstabel In uw gebruikerstabel staan alle gebruikers die toegang hebben tot de performers. Indien u reeds een tabel heeft voor uw gebruikersbeheer kunt u deze aanpassen, indien u nog geen tabel heeft zult u deze moeten aanmaken. Dit kan bijvoorbeeld een accounttabel zijn, waarin u zelf tegoeden bijhoudt of een tabel die door uw payment service provider wordt gevuld met betalende sessies. Variabele Uitleg Type Lengte Id Het unieke ID van de sessie Integer 11 Nickname De naam van de bezoeker Varchar 32 Status Of de bezoeker toegang heeft Int 11 Performer_id Het ID van de performer die bezocht wordt Int 11 LiveMaster_ID Het ID van de LiveMastersessie Int 11 U kunt deze tabel uiteraard uitbreiden met een start / stoptijd / ip logging en andere gegevens die u wenst bij te houden van uw betaalsessie. 5. Het maken van de communicatie URL Een communcation-url is een script dat bij u op de server staat en weergeeft of een bezoeker toegang heeft tot een bepaalde performer. Dit script genereert de XML-file en bevat de gegevens uit uw database. Een voorbeeld van de inhoud van een communcation-url: <session> <access>true</access> <nickname>jan</nickname> <performerid>5000</performerid> <trigger>001</trigger> <maxtime>100</maxtime> <checktime>10</checktime> <redirect_url>http://www.livemaster.nl/livedemo/members</redirect_url> </session> Pagina: 5
De elementen die in de XML moeten worden opgenomen zijn: Variabele Uitleg Type Lengte Access Toegang (TRUE = JA / ANDERS = NEE) Varchar 12 Nickname De naam van de bezoeker Varchar 32 Trigger Een code die wij opslaan ter controle van de aanroep Int 11 Performerid Het ID van de performer die bezocht wordt Int 11 Maxtime De maximale duur van de sessie (seconden) Int 11 Checktime De tijd tussen elke controle aanroep (seconden) Int 11 6. De communicatie-url argumenten LiveMaster roept uw communicatie-url aan met een aantal argumenten. Om het voor u mogelijk te maken de url in iedere mogelijke vorm te definieren, gebruikt u zogenaamde placeholders in uw url. Bij het aanroepen van uw url, worden de placeholders vervangen door de betreffende waarden. U bepaalt dus zodoende zelf de naam van de gebruikte argumenten. De placeholders die u kunt gebruiken zijn: Placeholder #type# #session_id# #livemaster_id# #performer_id# Uitleg Het soort aanroep: load, start, stop, check Uw programma sessie van de bezoeker. Het LiveMaster ID van de bezoeker sessie. Het ID van de performer dat tijdens de sessie wordt bezocht. Uw url kan bijvoorbeeld zijn: http://www.google.nl/livemaster.php? type=#type#&session_id=#session_id#&performer_id=#performer_id#&livemaster_id=#livemaster_id# Maar ook de onderstaande url is met gebruik van de placeholders mogelijk: http://www.google.nl/livemaster/#type#/#session_id#/#performer_id#/#livemaster_id# Alle placeholders zijn lowercase Pagina: 6
7. Design van de applicatie wijzigen U kunt het uiterlijk van de chatapplicatie aanpassen aan de vormgeving van uw programma. Hierdoor blijft de bezoeker binnen de vertrouwde vormgeving van de rest van uw website en zal zo niet het idee hebben de website te verlaten voor het chatten. Om het design van de applicatie eenvoudig te kunnen wijzigen, wordt gebruikt gemaakt van enkele afbeeldingen. Deze afbeeldingen worden als achtergrond van de chatapplicatie gebruikt. U hoeft voor het aanpassen van het design dus enkel een viertal afbeeldingen te maken. Afbeelding Omschrijving Formaat (h * b) Achtergrond van de applicatie Er wordt gebruik gemaakt van een 1024px breed, 768px hoog afbeelding voor de achtergrond van de applicatie. Achtergrond cambeeld Het cambeeld kan binnen de applicatie 468px breed, 369px hoog worden verplaatst en vergroot. Deze afbeelding wordt als achtergrond van het blok voor het cambeeld gebruikt. Foto-/filmvenster Een performer heeft de mogelijkheid films 401px breed, 301px hoog en foto's van zichzelf te plaatsen. Deze worden getoond in een popup. De afbeelding wordt als achtergrond van dit blok gebruikt. Infoblok De gegevens van een performer worden in een blok getoond. Deze afbeelding wordt als achtergrond van dit blok gebruikt. 550px breed, 400px hoog Omdat alleen de achtergrond afbeelding wordt aangepast en niet de layout van de applicatie zelf, moet u bij het vormgeven van de afbeelding rekening houden met de plaatsing van de onderdelen. Zo moet u op specifieke plaatsen ruimte vrijlaten voor het webcambeeld en de chatconversatie. Op de voorbeeldafbeeldingen is de layout weergegeven. Deze kunt u als basis gebruiken voor de vormgeving. Pagina: 7
Voorbeeld bij gebruik Payment Service Provider (PSP) In dit voorbeeld geven wij beknopt de werkwijze aan waarop u binnen uw membersarea uw bezoekers naar de performers van LiveMaster stuurt. In de onderstaande stappen wordt de status van uw bezoekertabel weergegeven en de waarden die de XML op dat moment moet bevatten. Stap 1: Start, de tabel is leeg Er zijn nog geen bezoekers binnen uw membersarea. De bezoekertabel is leeg. ID Nickname Status LiveMaster ID Performer ID (LEEG) (LEEG) (LEEG) (LEEG) (LEEG) Stap 2: De bezoeker betaald via uw PSP Bezoeker wordt in uw database geplaatst door de PSP ID Nickname Status LiveMaster ID Performer ID 123456 (LEEG) 1 (LEEG) (LEEG) Stap 3: De bezoeker komt uit bij uw membersarea en kiest voor zichzelf een nickname De nickname wordt bij de bezoeker in de database opgeslagen. ID Nickname Status LiveMaster ID Performer ID 123456 GEKOZENNAAM 1 (LEEG) (LEEG) Stap 4: De bezoeker kiest een performer De bezoeker kiest in uw membersarea een performer uit. U opent een nieuwe pagina en slaat daarbij het selecteerde performer ID in de database bij de bezoeker op. ID Nickname Status LiveMaster ID Performer ID 123456 GEKOZENNAAM 1 (LEEG) PERFORMERID Stap 5: U laadt de chatapplicatie met het ID van de bezoeker U stuurt de bezoeker naar de LiveMasterapplicatie en geeft hierbij uw Program Key mee en uw eigen sessie ID. LiveMaster bepaalt vervolgens de locatie van het script op uw server dat het XML-bestand maakt en roept deze aan. Hierbij geeft LiveMaster als argument uw eigen sessie ID mee en de actie: LOAD. Pagina: 8
U controleert in uw database of er een sessie bestaat met het meegegeven session ID en geeft vervolgens de onderstaande XML terug: <session> <access>true</access> <nickname>jan</nickname> <performerid>5000</performerid> <trigger>001</trigger> <maxtime>100</maxtime> <checktime>10</checktime> <redirect_url>http://www.livemaster.nl/livedemo/members</redirect_url> </session> Hierbij wordt er van uitgegaan dat de bezoeker mag chatten met de performer. Is dit niet het geval, dan geeft u bij het element <access> FALSE aan. Stap 6: De chatsessie wordt gestart U heeft aangegeven dat de bezoeker mag chatten met de performer. LiveMaster start de stream met de performer en roept vervolgens nogmaals uw communicatie-url aan. Hierbij wordt als argumenten uw eigen sessie ID, de actie START en een LiveMaster sessie ID meegegeven. U controleert nogmaals of de bezoeker mag chatten met de performer en slaat het LiveMaster sessie ID bij de bezoeker op. ID Nickname Status LiveMaster ID Performer ID 123456 GEKOZENNAAM 1 987654 PERFORMERID U geeft via XML terug: <session> <access>true</access> <nickname>jan</nickname> <performerid>5000</performerid> <trigger>001</trigger> <maxtime>100</maxtime> <checktime>10</checktime> <redirect_url>http://www.livemaster.nl/livedemo/members</redirect_url> </session> Pagina: 9
Stap 7: de sessie wordt gecontroleerd Nadat de checktime is verlopen, wordt uw communicatie-url opnieuw aangeroepen met uw eigen session ID, de actie CHECK en het Livemaster sessie ID. U controleert of de bezoeker nog toegang mag hebben tot de performer en geeft in XML terug: <session> <access>true</access> <nickname>jan</nickname> <performerid>5000</performerid> <trigger>001</trigger> <maxtime>100</maxtime> <checktime>10</checktime> <redirect_url>http://www.livemaster.nl/livedemo/members</redirect_url> </session> * Let op, controleer bij ieder CHECK zowel het Performer ID, uw eigen session ID en het Livemaster sessie ID. Op het moment dat de bezoeker een tweede performer opent, zal deze via de start de oorspronkelijke sessie updaten met een nieuw LiveMaster ID, waardoor bij de check aanroep van de eerste performer de sessie niet meer geldig zal zijn. Stap 8: De chatsessie wordt gestopt Sluit de bezoeker de chatapplicatie of geeft u bij de CHECK aanroep FALSE terug, dan wordt uw communicatie- URL aangeroepen met uw eigen session ID, het LiveMaster sessie ID en de actie STOP. U geeft via XML terug: <session> <access>true</access> <nickname>jan</nickname> <performerid>5000</performerid> <trigger>001</trigger> <maxtime>100</maxtime> <checktime>10</checktime> <redirect_url>http://www.livemaster.nl/livedemo/members</redirect_url> </session> Pagina: 10
Stap 9: De betaalsessie sessie wordt gestopt bij uw PSP Stopt de bezoeker met betalen, dan update u de rij van de bezoeker in uw databasetabel. In dit voorbeeld geeft u het veld status een waarde 2 (=betaling gestopt). Controleert u bij alle aanroepen van uw communicatie-url of de bezoeker nog betaalt, dan zal na beëindiging van de betaling uw communicatie-url het element <access> de waarde FALSE hebben. ID Nickname Status LiveMaster ID Performer ID 123456 GEKOZENNAAM 2 987654 PERFORMERID De bezoeker krijgt geen toegang tot de chatapplicatie als er geen geldige sessie wordt gevonden (= een sessie met 1 als waarde voor status) en de bezoeker geen toegang krijgt. Mocht uw communicatie-url toch worden aangeroepen, dan geeft u terug: <session> <access>false</access> <nickname>jan</nickname> <performerid>5000</performerid> <trigger>001</trigger> <maxtime>100</maxtime> <checktime>10</checktime> <redirect_url>http://www.livemaster.nl/livedemo/members</redirect_url> </session> Pagina: 11
Loggen met de communicatie-url Het is mogelijk om zelf bij te houden hoe lang een bezoeker naar een bepaalde performer heeft gekeken. U krijgt zo een goed beeld van het aantal chatsessies en de verbruikte minuten. Bij het aanroepen van de communicatie-url wordt als argument altijd type meegegeven. Zo weet u welke actie u moet uitvoeren en welke waarden de LiveMasterapplicatie in uw XML-file verwacht. Er zijn in principe 4 mogelijke waarden voor het argument type: load start check stop Wordt de 1 e keer meegegeven als de bezoeker de applicatie wil laden. Als resultaat geeft u aan of de bezoeker de chatapplicatie mag laden, met welke performer hij wil chatten en welke nickname hij hierbij gebruikt. Wordt meegegeven als de applicatie daadwerkelijk gestart is. De check wordt meegegeven als er een toegangscontrole plaatsvindt. Deze check wordt om de # aantal seconden aangeroepen zolang de bezoeker de chatapplicatie open heeft. U geeft bij iedere aanroep aan of de bezoeker toegang mag hebben en zorgt er zodoende voor dat de bezoeker niet kan kijken zonder hiervoor te betalen. Wordt meegegeven als er geen toegang meer is tot de applicatie, bijvoorbeeld omdat de bezoeker de chatapplicatie heeft gesloten of u access=false heeft aangegeven bij de check-aanroep. Stel uw programma gebruikt als domeinnaam www.mijnwebcamurl.nl en bij uw communicatie-url heeft de naam communicate.php opgeven. LiveMaster zal dan de volgende URL aanroepen: http://www.mijnwebcamurl/communicatie.php?session=123456&type=check&livemaster_id=987654 Logt u alle aanroepen van uw communicatie-url, dan kunt u een gedetailleerd overzicht genereren van het aantal minuten dat er bv per maand door bezoekers van de applicatie gebruik is gemaakt. Bijvoorbeeld: bezoeker Jan heeft van 23.00 tot 23.02 met performer 5000 gechat. Slaat u alle aanroepen op, dan heeft u in uw logdatabase een aantal regels staan met het session id van Jan (123456), zijn nickname (Jan), het livemaster sessie ID (987654), het ID van de performer (5000), het type actie (LOAD, START, CHECK, STOP) en het tijdstip van de aanroep. Pagina: 12