Integration Overview Web Services and Single Sign On
Table of Contents Overview...3 Quick Start 1-2-3...4 Single Sign-On...6 Background... 6 Setup... 6 Programming SSO... 7 Web Services API...8 What is STWS API?... 8 How the API works... 8 Online Interface Overview... 8 Uses for STWS... 9 Software Development Kit (SDK)... 10 Next Steps...11
Overview The StratusTime Integration consists of three different components. 1. Quick Start This section skips all details and provides step by step instructions for setting up Web Services 2. Single Sign-On (SSO) SSO supports the ability to login a user without the need of re-entering their credentials. 3. Web Services API Allows external systems to update and retrieve data from StratusTime. Examples include employee data and time card data. 4. Software Development Kit (SDK) The SDK is a windows based application that guides programmers through integrating with StratusTime. It is written with Microsoft C# and includes source code samples.
Quick Start 1-2-3 1. Enable brand level services by logging into the Brand Admin a. Browse to: https://stratustime.centralservers.com b. Enter Credentials: ClientID: BrandAdmin Login: Your Login and Password Note: Your URL might be different. If you re not sure what URL to use please send an email to webapi@nettimesolutions.com c. In Brand Admin Choose: Brand Management > Brand Setup > Brand Name > Web Service Enable Web Services & Enable SSO Copy Keys 2. Enable client level services by logging into the Configuration Editor a. Browse to: https://stratustime.centralservers.com b. Enter Credentials: ClientID: Your Client ID Login: Your Login and Password Don t know your credentials email webapi@nettimesolutions.com c. In Configuration choose: General > Web Services Enable Web Services & Enable SSO Enter wsuser password Assign a Feature Access Template Copy Keys (for client level only access) 3. Create a token to establish Web services connections a. Browse to: https://stratustime.centralservers.com/service/home/library b. Choose WS-JSON > TokenCreate [Post] Enter In: { "CustomerAlias":"YOUR_CUSTOMER_ALIAS", "SharedKey":"YOUR_SHARED_KEY", "UserName":"wsuser", "UserPass":"WS-USER_PASSWORD" } c. Use the generated returned token to connect to any of the available web services d. This process will be the same for XML and SOAP based calls. See the SDK for SOAP examples
Single Sign-On Background StratusTime support the ability to login a user without the need of re-entering their credentials. In this manner users will have a seamless experience when logging into StratusTime from another system. This section will outline how to setup the system to enable SSO on the system and how to perform it programmatically. Note that StratusTime does support multiple SSO methods (ex. SAML). This method is a simple, secure and quick implementation of SSO. Setup To enable SSO it will need to be enabled on the account. This is done in the Configuration interface under General => Web Services. You will need the proper permission levels in the system to enable this functionality. Please see your administrator of StratusTime or call support. Figure 1: Enable SSO 1 Once you are in the Web Services section you will need to Enable SSO At this time a Shared Key GUID will be issued. This is the key that you pass when working with the SSO API (note that the key in the screen shot will not work) The Web Access and SSO option allows users to login via StratusTime or SSO. If you select SSO Login only the StratusTime login will be disabled. The only way to access the application will be via SSO. Note: If you are a partner and need to implement SSO across all your customers please contact client services. A special SSO GUID will be issued that will work across all your customers.
Programming SSO The sequence diagram below describes a typical SSO validation. External System 1) Call SSOLinkByEmployeeID 2) Returns Login URL 3) Redirect to LoginSSO.aspx w/url from step #2
Web Services API What is STWS API? The StratusTime Web Services (STWS) API is designed to allow external systems to connect with the StratusTime SaaS engine. StratusTime has multiple methods to import and export data out of its data store including flat files, FTP and web services. The STWS API is designed for end users to consume and send data via XML, JSON, or SOAP. How the API works STWS is composed of 3 different web service URLs. Users can use any language they want to interact with the STWS API, as long as the languages use JSON, XML, or SOAP as the standard for sending and receiving the data. The layout is defined as: https://stratustime.centralservers.com/service/ws-[standard]/[version]. Below are the service URLs that can currently be used. https://stratustime.centralservers.com/service/ws-xml/1.0 https://stratustime.centralservers.com/service/ws-json/1.0 https://stratustime.centralservers.com/service/ws-soap/1.0 Note: The example above is using StratusTime.centralservers.com URL. For partners that have their own unique URL you will use your custom URL. Online Interface Overview The main library interface is designed to help end users rapidly view and test the data that is required to construct communications with the available web services. Figure 3 shows the main areas of the library interface. In order to test a Web Service click on any one of the method links to open a Service Test Form Dialog. Figure 1: API Library
In addition to the documented methods you will also be able to view properties of these. Figure 2: Method Properties Uses for STWS The STWS API can be used for many purposes. For example, the STWS can be used to send Employee Indicative Information including additions and updates. Employee Data Exchange (UserInfo) Add, Update, Delete employee information in StratusTime Configuration (Labor) Add, Update, Delete Labor Level information Time Data (Time) Retrieve time card data for employees for a defined date range Insert a punch within the system (examples of punches include clock in, clock out, start break, end break, start meal, end meal and transfer). This is used when you want to integrate another system where the employee may do the actual punch (ex. Point of Sale) but have StratusTime perform all the rules calculation.
Software Development Kit (SDK) The SDK is a sample application written in Microsoft C# that allows you to see how to use API. The goal of the SDK is to give the developer a quick start to understanding and working with the API. It can be downloaded at https://stratustime.centralservers.com/service/home/about Figure 3: SDK Download Figure 4: Visual Studio with StratusTime SDK
Figure 5: SDK Configuration Requirement for the SDK is Microsoft Visual Studio 2010 (C# programming language). System Help Throughout the application there are help icon on various pages; please click on each icon to read the details for how to use that particular interface and its associated inputs. Running the App In order to successfully run the application you can just hit F5. However because the Web services will be updated periodically you will need to update the service reference. To do this follow the instructions found within the help on this page. Next Steps You have already taken the first step, which is to read this document. Next, we encourage you to download the SDK and take a quick look at the code. After the code review if you would like to speak to one of our technical staff we will be more than happy to do a call to review integration strategies and answer any questions you may have. Last, you will be assigned a technical representative that will be available during your integration process.