WinFlex Web Single Sign-On (EbixLife XML Format) Version: 1.5

Transcription

1 WinFlex Web Single Sign-On (EbixLife XML Frmat) Versin: 1.5 The gal f this dcument is t specify and explre the basic peratins that are required t facilitate a vendr applicatin requesting access t the WinFlex Web user interface and returning t the vendr user interface. Fr WinFlex, this interface can be used t prvide a methd f creating users n the system as well as seamlessly lgging them in and passing case data n future requests. Calling WinFlex Web Fr this versin f the service, we will use the HTTPS POST methd - The prtcl used. as a secure cnnectin is required. - The web page URL (ie; the web server name, dmain and any ther lcatin). This can take the frm f - The parameter name is defined as llxml=<xml-message> (LLXML). - Use an http POST request s the xml-message is nt shwn n the URL and a dcument f any length may be passed. Based n the abve infrmatin, we can create a cmplete frm request using the fllwing prtcl, frmat and parameters: Example: with the parameter llxml=<xml-message>* * This URL is subject t change. Cntact EbixLife, Inc. fr the actual URL when implementing Single Sign-On. The <xml-message> refers t the cmplete xml dcument that has been URL-encded t allw it t be passed as a parameter value in an http pst request. The primary ndes f <xml-message> are defined as fllws: - Glbal LL nde - Errr nde - WinFlex nde The namespace used fr the schema is urn:lifelink-schema. The WinFlex XML Dcument LL nde: The LL XML nde cntains multiple bjects that are used t fulfill a request. The full LL bject is included in bth the request and the respnse. Each request t the llxml web services requires a single LL bject. The bject includes: LginType The LginType attribute tells the receiving applicatin hw t prcess the request fr access. Enumerated value: LL_NONE Nt used WF_CARRIER All carrier access shuld be perfrmed under this lgin type WF_AGENCY All agency access shuld be perfrmed under this lgin type WF_3RDPARTY Used fr 3 rd Party vendr access t WinFlex Web Page 1 f [email protected]

2 Page 2 f [email protected]

3 UserName Each individual WinFlex user has a unique user name. The user name is nt the actual WinFlex Web user name, but a unique ID representing the user in the calling system. During the curse f the single sign-n prcess, the ID will be linked with a WinFlex Web accunt, either previusly existing, r newly created.(required) WFCmpanyCde When calling WinFlex, this field is required t identify the cmpany sending the request. EbixLife will assign this value. WFCmpanyPasswrd When calling WinFlex, this field is required in cnjunctin with the WFCmpanyCde in rder t validate the calling vendr. Assigned by EbixLife. InterfaceType There are tw main types f interfaces with r withut a user interface. The types f GUI and NGUI will indicate whether the user will navigate thrugh the EbixLife user interface r nt. Fr the initial versin f the LL XML Interface, the GUI versin will take the user t Step 1 f the tl specified. In subsequent versins, the client sftware can specify a starting lcatin fr each tl. (required) With the nn-gui versin, n user interface is displayed and the resulting utput is returned in an xml frmat. If pdf r emf utput is returned, the related xml nde will indicate where t find the resulting utput files (as urls). OutputType (XML, PDF, XMLPDF, EMF, URL, XML_RAW) Varius utput types may be supprted by the LLP XML interface in the future. (required) NGUI XML - Returns all xml. N PDF link is included PDF - Returns all xml. PDF link is included in specific prduct nde XMLPDF - Returns all xml infrmatin as well as a link t the PDF EMF - Nt supprted at this time URL - Nt supprted at this time XML_RAW - Same as XML GUI XML - Psts XML t ReturnButtn/PstAddress if exists. PDF - Displays PDF if ReturnButtn/ViewFirst is 1. Otherwise link is created in XML returned t ReturnButtn/PstAddress if exists. XMLPDF - Cmbinatin f XML and PDF EMF - Nt supprted at this time URL - ll.aspx returns the URL t be redirected t r empty string if errr ccurred XML_RAW - Displays the full prcessed XML Tl There are currently five EbixLife tls: VitalSigns, VitalTerm, VitalLTC, VitalUL, and WinFlex. Depending n the type f utput requested, the vendr sftware may include up t ne tl sectin fr each LL tl. Fr GUI interface type, the user interface will start at the first tl specified. The remaining tls will be initialized with the specified infrmatin, but the user will be required t navigate t it. Fr the PDF utput type, each tl will be prcessed in the rder they are received. (required) Name The tl name field shuld be WinFlex. (required) Nte: Fr the first versin f the xml interface, the StartLcatin will be ignred. Users will autmatically be ruted t the first step f the tl. The infrmatin in the input xml may r may nt ppulate mre infrmatin than is shwn n the first step f each tl. Page 3 f [email protected]

4 Example: <LL LginType= LL_NONE > <UserName>bbtest123</UserName> <LOLAKey>generatedkey</LOLAKey> <InterfaceType>GUI</InterfaceType> <OutputType>XML</OutputType> <Tl> <Name>WinFlex</Name> </Tl> <Tl> <Name>VS</Name> <StartLcatin>1</StartLcatin> </Tl> </LL> Client nde: The Client XML nde cntains the details abut the insurance prduct client. The nde includes: Applicant The primary applicant persnal infrmatin FirstName The firstname f the client. MiddleName The client s middle name r initial LastName The client s surname Birthdate mm/dd/yyyy frmatted client s birthdate Age Current age f the client, used when the birthdate is nt specified. May be interpreted as AgeLast fr sme tls. (required) AgeNearest Nearest age that may be used alternatively if a birthdate is nt specified and a particular insurance prduct is sld based n the client s nearest age. (required) Sex Male r Female (required) MaritalStatus Single r Married Spuse The persnal infrmatin f the primary applicant s spuse FirstName The firstname f the client MiddleName The client s middle name r initial LastName The client s surname Birthdate - mm/dd/yyyy frmatted client s spuse s birthdate Age Current age f the client, used when the birthdate is nt specified. May be interpreted as AgeLast fr sme tls. AgeNearest Nearest age that may be used alternatively if a birthdate is nt specified and a particular insurance prduct is sld based n the client s nearest age. Sex - Male r Female StateOfIssue Tw letter state abbreviatin where the insurance plicy is t be issued. (required) Example: <Client> <Applicant> <FirstName>Haley</FirstName> <MiddleInitial>J</MiddleInitial> <LastName>Osment</LastName> <Age>14</Age> <AgeNearest>14</AgeNearest> Page 4 f [email protected]

5 <Sex>Male</Sex> <MaritalStatus>Single</MaritalStatus> </Applicant> <State>CA</State> </Client> Errr nde: The Errr XML nde allws EbixLife t reprt back t the vendr applicatin with errrs r warnings that may have ccurred during the prcessing f a request. These errrs refer t general errrs abut the EbixLife interface request. Errrs that are specifically related t any particular EbixLife tl are included with the xml utput fr that tl. Errr Details abut a single errr. Multiple errrs may be included. Type Defines the severity f the errr. Pssible values are Errr, Warning, and Message, with Errr defining a fatal errr with n recvery and Message just prviding infrmatin. Number Errr numbers may be assigned and dcumented that help identify the errrs. When reprting back t EbixLife Inc., the errr number may be a useful tl in identifying a prblem. Descriptin Text descriptin f the errr. The client applicatin culd display this text t the user r lg in the applicatin. Surce LLP surce cmpnent that raised the errr. Methd LLP methd f the surce that raised the errr. Example: <Errr> <Type>Errr</Type> <Number>234</Number> <Descriptin> N valid request infrmatin prvided. </Descriptin> <Surce>clsLLInterface</Surce> <Methd>Initialize</Methd> </Errr> WinFlex nde: The WinFlex XML nde allws the vendr t create, lgin, and pass case data t the WinFlex Web System. The WinFlex nde includes: ReturnURL (ptinal) Describes the URL t which WinFlex will return when prcessing is cmplete; A parameter f xmlife will be POSTED t this URL upn cmpletin. See the XMLife implementatin guide fr mre infrmatin. XMLifeDc (ptinal) The XMLife paylad t be used t create an illustratin within WinFlex Web Captive - (ptinal) Marks the user as a captive user within WinFlex Web. The user will be unable t request access t additinal carriers/agencies. Values: True False Plicy (ptinal) Used t send additinal infrmatin t WinFlex Web t be preladed int the WinFlex Web applet Cmpany (ptinal) - Describes the default cmpany t be laded int WinFlex Web. Cde The WinFlex cmpany cde representing the cmpany t prelad. Page 5 f [email protected]

6 Prduct Describes the default prduct t be laded int WinFlex Web. Cde The WinFlex prduct cde representing the prduct t prelad. Cncept Describes the default Cncept t be laded Cde The WinFlex cncept cde representing the cncept t prelad. Insured (ptinal) Infrmatin abut a client t be pre-laded int WinFlex Web FirstName LastName Age Sex BirthDate State Insured2 (ptinal) Infrmatin abut an ptinal secnd insured t be preladed in WinFlex FirstName LastName Age Sex BirthDate State Agent (ptinal) Agent infrmatin t be pre-laded int WinFlex Web FirstName LastName Cmpany Address1 Address2 Address3 City State Zip Phne Fax License Premium (ptinal) An ptinal premium t be pre-laded int WinFlex Web FaceAmunt (ptinal) An ptinal Death Benefit t be pre-laded int WinFlex Web Prfile (ptinal) Prfile infrmatin used t pre-ppulate the registratin page upn new user registratin. This may be sent every time, but will be ignred if the user is already registered. Available elements are: FirstName LastName Initial Credentials CmpanyName Address1 Address2 City State Zip Phne Fax Page 6 f [email protected]

7 Example: <WinFlex> <ReturnURL> <XMLifeDc> <TXLife> :: :: :: </TXLife> </XMLifeDc> <Captive>False</Captive> <Plicy> <Cmpany> <Cde>DEMO</Cde> <Prduct> <Cde>DEMOUL</Cde> </Prduct> </Cmpany> <Insured> <FirstName>Mr</FirstName> <LastName>Client</LastName> <Age>45</Age> <Sex>M</Sex> <State>CA</State> </Insured> <Agent> <FirstName>Sam</FirstName> <LastName>Agent</LastName> <Cmpany>Sme Cmpany</Cmpany> <Address1>Sme Street</Address1> <City>Sme City</City> <State>UT</State> <Zip>55555</Zip> <Phne> </Phne> <Fax> </Fax> <License> </License> </Agent> <Premium> </Premium> </Plicy> <Prfile> <FirstName>Sme</FirstName> <LastName>Persn</LastName> <CmpanyName>A Cmpany</CmpanyName> <Address1>100 Anywhere Ln</Address1> <City>Sme City</City> <State>CA</State> <Zip>55555</Zip> <Phne> </Phne> </Prfile> </WinFlex> Page 7 f [email protected]

8 Linking t WinFlex Web The current link t WinFlex Web supprts nly the GUI Interface Type. Future versins will supprt the NOGUI Interface Type as well as varius data return types (XML, PDF, etc.). When linking t WinFlex Web, the fllwing fields are required: LL nde LginType (attribute) UserName The UserName nde is nt actually a username in the WinFlex Web schema, but a unique ID r name identifying the user in the calling vendr s system. This ID is used by WinFlex t link t the user s accunt in subsequent calls t WinFlex Web. WFCmpanyCde This item is assigned by EbixLife Inc. and is unique t the carrier / agency. WFCmpanyPasswrd This item is assigned by EbixLife Inc. This will be a 20 digit alpha-numeric key that will be used in cnjunctin with the WFCmpanyCde t authenticate that the request is cming frm a trusted surce. InterfaceType Tl Name The WinFlex nde is ptinal and is used fr sending additinal data t WinFlex Web upn startup. The Plicy nde is used t pre-pplulate values within the WinFlex Web applet. The Prfile nde may be used t pass prfile infrmatin t be pre-ppulated upn registratin. Bth ndes are ptinal, but may be passed with every call. The Prfile nde is ignred if the user has already registered fr WinFlex Web. An example EbixLife XML dcument fr use with WinFlex Web is shwn belw: <LL LginType= WF_AGENCY > <UserName>testuser</UserName> <WFCmpanyCde>DEMO</WFCmpanyCde> <WFCmpanyPasswrd>aij4l2n5wm05dzu71gp</WFCmpanyPasswrd> <InterfaceType>GUI</InterfaceType> <OutputType>URL</OutputType> <Tl> <Name>WinFlex</Name> </Tl> </LL> <WinFlex> <Captive>False</Captive> <Plicy> <Cmpany> <Cde>DEMO</Cde> <Prduct> <Cde>DEMOPROD</Cde> <Cncept> <Cde>LEDGER</Cde> </Cncept> </Prduct> </Cmpany> <Insured> <FirstName>Sme</FirstName> Page 8 f [email protected]

9 <LastName>Persn</LastName> <Age>29</Age> <Sex>M</Sex> <BirthDate> </BirthDate> </Insured> <!-- Insured 2 used fr Survivrship prducts <Insured2> <FirstName/> <LastName/> <Age/> <Sex/> <BirthDate/> </Insured2> --> <Agent> <FirstName>Dem</FirstName> <LastName>Agent</LastName> <Cmpany>Sme Cmpany</Cmpany> <Address1>Anywhere Street</Address1> <Address2/> <Address3/> <Phne> </Phne> <Fax> </Fax> < >[email protected]</ > <License> </License> </Agent> <Premium> </Premium> <FaceAmunt>0.0</FaceAmunt> </Plicy> <Prfile> <FirstName>Sme</FirstName> <LastName>Persn</LastName> <CmpanyName>A Cmpany</CmpanyName> <Address1>100 Anywhere Ln</Address1> <City>Sme City</City> <State>CA</State> <Zip>55555</Zip> <Phne> </Phne> < >[email protected]</ > </Prfile> </WinFlex> The example shwn abve will lg the user int the system (if he/she exists) and lad WinFlex Web with the infrmatin prvided in the WinFlex nde. If the user des nt exist, he/she will be prmpted t cmplete the WinFlex Web registratin prcess. The data in the Prfile nde will be used t pre-fill the registratin frm. Upn receiving cnfirmatin f registratin and carrier/agency apprval, subsequent attempts t lg int WinFlex Web will be seamless frm the vendr s applicatin/website. XMLife Requests When making a request t WinFlex Web with the XMLifeDc element ppulated, WinFlex will expect a valid XMLife Illustratin request dcument t be ppulated int this field. If an XMLife result is expected, the calling system must pass a valid URL thrugh the ReturnURL element lcated in the WinFlex nde. Upn cmpletin f prcessing, an XMLifeResult dcument will be generated and POSTED t the URL prvided. Page 9 f [email protected]