Companywebcast API Wiki
Navigation
Cwc API Home
PlayerSDK
Meta Service
Getting Started
Creating a client
Methods
Data Types
Understanding Webcast security
Management Service
Getting Started
Creating a client
Methods
Data Types
Quick Search
Advanced Search »
Back
History
Akoestiq/Liveuitvaart Koppeling
{TOC} ==Project beschrijving== ===Doelstelling=== '''doel 1''' : Realiseer de mogelijkheid om vanuit Akoestiq webcasts aan te maken, zodat deze aangeboden worden via Liveuitvaart.nl.{BR} '''doel 2''' : Ontsluit de functionaliteit van Liveuitvaart.nl binnen de Akoestiq interface. ===Implementatie=== '''doel 1''' : :__Akoestiq__ ::Implementeert Single Sign On{BR} ::Consumeert Management Service :::Maakt Webcasts aan :::Wijzigt Webcasts :::Implementeert Gedeeld DataModel :__Liveuitvaart.nl__ ::Implementeert Single Sign On ::Consumeert Management Service :::Wijzigt Webcasts (soms) :::Implementeert Gedeeld DataModel [image|Project schema|{UP}Akoestiq%2fproject_schematic.jpg] '''doel 2''' : :Doel 2 kan pas gerealiseerd worden na de succesvolle afronding van doel 1. ::Liveuitvaart.nl wordt in een IFRAME geladen binnen Akoestiq. ::Liveuitvaart.nl doet een inspanning om visueel aan te sluiten op Akoestiq. ::Liveuitvaart.nl verbergt overlappende functionaliteit. ==Definities== ===Akoestiq=== Een applicatie van MK2, die wordt aangeschaft door Customers om audio playlists samen te stellen, in te plannen en af te spelen. ===Customer=== Een uitvaart centrum dat Akoestiq in gebruikt heeft. Elke Customer heeft minimaal 1 Profile. Op dit moment zijn er 3 Customers: {{{{ <table width=400> <tr><td>'''Name'''</td><td>'''Account'''</td><td>'''Profiles'''</td></tr> <tr><td>AkoestiqKlant1</td><td>klant01user / H5GpDRh5</td><td>1</td></tr> <tr><td>AkoestiqKlant2</td><td>klant02user / CgDwE$a#</td><td>1</td></tr> <tr><td>AkoestiqKlant3</td><td>klant03user / XcYbCsga</td><td>2</td></tr> </table> }}}} Accounts in de context van een Customer geven enkel toegang tot de webcasts van die specifieke Customer.{BR} De "akoestiq" Account geeft toegang tot alle Customers. __Het aanmaken, bewerken en verwijderen van Customers is niet binnen de scope van deze koppeling.__ :Relevante Methods: ::[ManagementService_2.0_Methods.ashx#CustomerList_1|CustomerList] ::[ManagementService_2.0_Methods.ashx#CustomerGet_0|CustomerGet] :Relevante Types: ::[ManagementService_2.0_DataTypes.ashx#Customer|Customer] ::[ManagementService_2.0_DataTypes.ashx#CustomerSummary|CustomerSummary] ===Gedeeld DataModel=== Het data model dat Liveuitvaart.nl en Akoestiq beide moeten naleven om gegevens succesvol uit te kunnen wisselen. Dit zijn de koppeling specifieke eigenschappen die beide applicaties moeten uitwisselen: ::''NextOfKin-Saluation'' :::Aanhef van de nabestaande. bv. : "Beste". ::''NextOfKin-Initials'' :::Initialen van de nabestaande. bv. : "M.J.J." ::''NextOfKin-Preposition'' :::Tussenvoegsel van de nabestaande. bv. : "van der" ::''NextOfKin-LastName'' :::Achternaam van de nabestaande. bv. : "Brouns" ::''NextOfKin-Email'' :::Email adres van de nabestaande. bv. : "mjj@mail.com" ::''Deceased-Name'' :::Naam van de overledene. bv. : "Wifred Wijlen" ::''Deceased-DateOfBirth'' :::Geboortedatum van de overledene. ::''Deceased-DateOfDeath'' :::Datum van overleiden. ::''Contractor-Name'' :::Naam van de [#Uitvaart_Ondernemer_8|Uitvaart Ondernemer]. ::''Contractor-Email'' :::Email adres van de [#Uitvaart_Ondernemer_8|Uitvaart Ondernemer]. Omdat de Management Service geen native ondersteuning heeft voor deze data types, gebruiken we [ManagementService_2.0_DataTypes.ashx#GenericItem|GenericItems] om de data aan een Webcast te plakken.{BR} Alle data die specifiek is voor de uitvaart applicaties wordt bewaard in deze GenericItems. {BR}{BR} Deze opzet is uitgewerkt in [AkoestiqLiveuitvaartCodeSample|management_sample.php]. ===Liveuitvaart.nl=== Een web applicatie van Company Webcast. Geïnteresseerden kunnen via deze site live en ondemand kijken naar een uitvaart, ook is er een uitgebreide management omgeving gericht op Customers en Uitvaart Ondernemers. {BR}{BR} :Url: ::[http://akoestiq.liveuitvaart.nl/manage|http://akoestiq.liveuitvaart.nl/manage] :Account: ::developer / l#2rVK ===Management Service=== Een SOAP 1.1 Web Service van Company Webcast.{BR} Hiermee worden Webcasts aangemaakt, gewijzigd en verwijderd.{BR}{BR} :WSDL : {BR} ::[https://services.companywebcast.com/management/2.0/managementservice.svc?wsdl|https://services.companywebcast.com/management/2.0/managementservice.svc?wsdl]{BR} :Documentatie:{BR} ::[http://api.companywebcast.com/ManagementService_2.0_Home.ashx|http://api.companywebcast.com/ManagementService_2.0_Home.ashx]{BR} :Code voorbeeld:{BR} ::[AkoestiqLiveuitvaartCodeSample|management_sample.php] :Account: ::akoestiq / !BhSSD#P (toegang tot alle Customers) ::klant01user / H5GpDRh5 (toegang tot Customer AkoestiqKlant1) ::klant02user / CgDwE$a# (toegang tot Customer AkoestiqKlant2) ::klant03user / XcYbCsga (toegang tot Customer AkoestiqKlant3) ===management_sample.php=== Een in PHP geschreven voorbeeld dat alle in dit document benoemde methods, types en mechanismes demonstreert.{BR} [AkoestiqLiveuitvaartCodeSample|management_sample.php] ===Profile=== Een “template” op basis waarvan een Webcast gecreëerd wordt. {BR} Voor iedere Encoder die aanwezig is bij een Customer bestaat een Profile. Dat betekend dus 1 per aangesloten ruimte/kamer/zaal.{BR} De Title eigenschap van elk Profile beschrijft de ruimte, bv. “Noord zaal”, “Zuid zaal”. :Relevante Methods: ::[ManagementService_2.0_Methods.ashx#CustomerList_1|CustomerList] ::[ManagementService_2.0_Methods.ashx#CustomerGet_0|CustomerGet] ::[ManagementService_2.0_Methods.ashx#WebcastCreate_2|WebcastCreate] ::[ManagementService_2.0_Methods.ashx#WebcastGet_4|WebcastGet] :Relevante Types ::[ManagementService_2.0_DataTypes.ashx#Customer|Customer] ::[ManagementService_2.0_DataTypes.ashx#Profile|Profile] ::[ManagementService_2.0_DataTypes.ashx#Webcast|Webcast] ===Single Sign On=== Het mechanisme dat voorkomt dat gebruikers apart moeten inloggen voor zowel Akoestiq als Liveuitvaart.nl. {BR}{BR} Authorizatie voor Liveuitvaart.nl is een proces van 2 stappen:{BR}{BR} :'''Stap 1: haal een authorizatie token op''' ::Roep de volgende URL aan in de PHP applicatie, waarbij [Username] en [Password] zijn vervangen door de klant specifieke Liveuitvaart.nl Account gegevens, verstrekt door Company Webcast. {BR} ((( ::http://akoestiq.liveuitvaart.nl/api/users/auth/?login_name=[Username]&password=[Password]))) {BR} ::In de test opstelling kan de verstrekte Liveuitvaart.nl Account gebruikt worden (developer / l#2rVK). {BR} ::In de response op deze request komt een Json geformatteerd data objectje terug, dat de ''authToken'' property heeft.{BR}Dit is de authorizatie token die je nodig hebt in stap 2. {BR} ::Een voorbeeld van hoe je dit in PHP kan doen: {BR} <code PHP> $r = file_get_contents('http://akoestiq.liveuitvaart.nl/api/users/auth/?'. 'login_name='.urlencode($Username).'&password='.urlencode($Password)); $AuthorizationToken = json_decode($r)->authToken; $URLAuthorizationToken = urlencode($AuthorizationToken); </code> :'''Stap 2: open de Liveuitvaart.nl management applicatie in een webbrowser''' ::Laad de volgende URL in een IFRAME of Browser window, waarbij [URLAuthorizationToken] is vervangen door de in Stap 1 opgehaalde token : {BR} ((( ::http://akoestiq.liveuitvaart.nl/manage-iframe/?auth_token=[URLAuthorizationToken]&iframe=true ))) ((('''Let op!'''{BR}1. Een authorizatie token is slechts 1 uur geldig, waarna het niet meer geaccepteerd wordt door Liveuitvaart.nl.{BR}2. In de komende dagen zal SSL beschikbaar worden voor het Liveuitvaart.nl domein, de gebruikte Urls zullen dan via "https" te benaderen zijn.))){BR} ===Uitvaart Ondernemer=== Een organisatie die cliënten aanbrengt bij een Customer (“uitvaart centrum”).{BR} Uitvaart Ondernemers zijn relevant in deze koppeling omdat Liveuitvaart.nl mailing en rapportage functionaliteit rondom “uitvaart ondernemers” heeft.{BR}{BR} Uitvaart Ondernemers zijn geïmplementeerd in ''Contractor-Name'' en ''Contractor-Email'', zie [#Gedeeld_DataModel_4|Gedeeld DataModel].