The TriSys Web Application Programming Interface (API) is a suite of web services which exposes recruitment business functionality to client-side applications running on any operating system on any type of device. The API exposes a ReST (Representational State Transfer) mechanism and uses the POST verb exclusively which handles JSON (JavaScript Object Notation) formatted requests and responses.
Overview
Introducing TriSys Web API
TriSys Web Application Programming Interface
The TriSys Web Application Programming Interface (API) is a suite of web services which exposes recruitment business functionality to client-side applications running on any operating system on any type of device.
The Web API is platform-agnostic, meaning that it can be called from client or server applications written in any programming language, running on any type of hardware. The Web API provides all methods and properties to allow web and mobile designers and developers to construct powerful line of business recruiting applications and technologies.
TriSys Web API provides the back-end to Windows and Mac desktop applications as well as all web browsers, tablets and phone apps.
Industrial Strength Business Functionality
The Web API provides a comprehensive suite of transactional based business services to allow web/mobile designers/developers to quickly build, manage and host sophisticated recruitment oriented systems such as:
Agency Web sites • Corporate Jobs Portals • Applicant Tracking Systems (ATS) • Job Boards • Customer Relationship Management (CRM) • Mobile Apps • Human Resources
TriSys Cloud Infrastructure
The TriSys cloud platform which underpins the API provides powerful and scalable computing infrastructure designed specifically for TriSys recruitment agency customers, and fully managed by TriSys Business Software and its partners.
TriSys' cloud comprises literally thousands of fault-tolerant, scalable and powerful servers running 24x7 in data centres throughout the world. TriSys has been supplying business grade industrial strength cloud computing to the recruitment industry since 2002 and has a range of technology products and services which are fully integrated with each other and the TriSys cloud.
Our cloud partners are the worlds biggest cloud computing suppliers: Microsoft, Google and Amazon.
This Documentation
This documentation is targetted at web/mobile designers and developers to help them integrate the TriSys back-end cloud services into their own client applications. Each namespace, category and method is described, with live code samples supplied to demonstrate the effectiveness of adopting the TriSys Web API and cloud infrastructure.
Recruitment Functionality
Recruitment Agency Web Sites
A typical recruitment agency will have at least a 'brochure' web site comprising static content. Some agencies may have dynamic content using a content management system (CMS), however the TriSys Web API provides the next level of sophistication, where live data from the recruitment agency CRM system is available in real-time, to candidates, clients and the job board and social networking ecosystems.
Agencies can not only display their live jobs, but provide sophisticated job searching and job alerts to their candidates. Candidates can register and login to apply for jobs and maintains their up to date CV and availability for work. Clients can search for candidates and maintain ther own portfolio of jobs, and schedule interviews and other interactions to help the hiring process run smoothly. Candidates and clients can respectively enter and authorise on-line timesheets, feeding data into invoicing and pay and bill gateways to allow effective back office workflow, saving time and money.
Corporate Jobs Portals
A corporate entity will typically have its own web design team with responsibility to manage the web presence and brand, and possibly complex business to business interactions with suppliers and business to consumer interactions with customers. Integration with the corporate enterprise resource planning (ERP) or CRM system is often time consuming and expensive, involving the IT department and senior management.
The TriSys Web API provides a cost effective alternative, providing a fully hosted programmable corporate recruiting hosted service allowing the web designers to focus on presentation and candidate experience, whilst also being able to pull though new hires directly into the corporate ERP/CRM systems on an as-needed basis.
The corporation can take advantage of a tried and tested candidate and job matching and workflow engine which can be easily integrated using the currently deployed web programming industry standards such as HTML/CSS and Javascript.
Applicant Tracking Systems
Deploying a fully-blown applicant tracking system to handle a few hundred (or less) jobs is not cost effective due to the licensing/setup/training costs associated with deploying a new system into an established IT infrastructure. By leveraging the TriSys Web API, you can quickly bolt on custom ATS functionality as needed, module by module, and pay only for what you use.
Jobs can be quickly published to social media and job boards and applicants can be efficiently funnelled through the system, ensuring a smooth workflow resulting in the placement of the right candidate for the position.
Job Boards
The TriSys Web API provides a cost-effective platform for any type of job board. The back end recruitment ATS/CRM capability understands the dynamics of candidates and jobs and provides an out of the box back-end storage and searching engine with full CRUD (create, read, update, delete) capability for clients, candidates, vacancies, placements and timesheets.
Job board companies can focus on building the candidate and client user interface without worrying about back-end performance or functionality, or getting to grips with complex back-end services, security and web remote procedure calls.
Customer Relationship Management
The TriSys Web API is effectively the back-end data layer from TriSys' own CRM system which has been in production for over 20 years. It is therefore a mature, highly functional and scalable CRM engine providing sophisticated transactions to manage clients, candidates, companies, requirements, placements, timesheets and much more.
TriSys Apex is the latest version of TriSys recruitment software for agencies to use the TriSys Web API, and is proof that the cloud hosted platform provides the functionality and reliability desired by recruitment agencies.
TriSys Business Software is not a recruitment company, but still uses TriSys as its CRM for managing a software/services company with cloud systems and help desk built it. It is therefore quite easy for a non-recruitment CRM system to utilise the TriSys Web API and cloud platform as a cost effective alternative to those other platforms in existence today.
Mobile Apps
TriSys' own mobile recruiting app uses the Web API to provide full desktop recruiting functionality to mobile devices. It is possible however to build micro-apps for specific business functionality such as job hunting, timesheets/bookings, social interactions and many more.
The TriSys Web API can be called from any mobile SDK such as Javascript, Java SDK (android), Objective C/Cocoa (iOS), C# (Xamarin and .Net) or Microsoft's new Universal App API for Windows Phone.
Human Resources
Some organisations do not need a fully blown ERP with integrated HR modules. Instead, utilising the TriSys Web API to manage confidential HR details off-site, may be a more cost effective alternative than attempting to solve this problem on-premise. As TriSys understands people and jobs, it is more suited to managing HR than most CRM systems and can easily be bolted on to the in-house custom crafted CRM solution, rather than developing or buying a completely new module/application suite.
Secure Access
Authentication
Client applications can be compiled desktop applications, mobile apps, or hybrid or web apps. They can be written in any programming language.
Each client application is allocated an API Key. This is a unique GUID based key which identifies all API calls made by the application. Each API Key is permitted to access one or more resources (databases, disk drives, files, functionality, services etc..) on the TriSys cloud infrastructure, only when supplied with login credentials.
Although each API Key allows access to computing recources held within the TriSys cloud, it is possible for an API Key to enable access to traditional 'on-premise' SQL Servers, active directories and files. In this scenario, the Web API uses firewall pinhole rules to privately and securely access the on-premise resources. The on-premise infrastructure is never exposed publicly.
The API Key can also be thought of as a public key. They key on its own does not identify or allow access to any resources.
If the client application provides services for agency clients and candidates, then it will also be allocated a TriSys CRM Credential Key. This is a unique GUID key which is welded to the API Key and effectively links a TriSys customer record held in TriSys' own internal CRM system with a user record in the recruitment agency cloud SQL Server database. This key must also be used when listing vacancies and when logging in clients and candidates.
The TriSys CRM Credential Key can also be thought of as a public key. They key on its own does identify or not allow access to any resources.
To access cloud resources, the client application must supply the API Key, and optionally the TriSys CRM Credential Key, in addition to login credentials, normally an e-mail address and a password for the user account logging into the client application. If these credentials are valid when authenticated against the TriSys cloud services, then a session based Data Services Key is returned to the client application.
The data services key is also a unique GUID based key which identifies the logged in user of the client application and permits access to the appropriate resources on the TriSys cloud.
The data services key can also be thought of as a dynamic expiring pointer to an internal private key. They key can only be used within the current client application session, and may expire after a certain amount of time, or will be invalid if the user explicitly logs out of the client application, or attempts to login with the same credentials on another device.
Standing Data
Client applications will typically provide a framework for its users to interact with the main business data entities (clients, candidates, jobs etc..), however there is also a need to have supporting and rarely changing data such as lookups, settings/preferences, job titles, attributes etc.. The Web API provides a way to read the entire suite of standing data into the application cache or to selectively request only those cached elements required for specific functionality.
Typically the standing data is retrieved after authentication, or each time the user logs into the client application, however reading the full cache for 'quick and dirty' operations such as displaying a list of vacancies on a home page is an expensive operation in terms of time and traffic. Check out this section to learn more.
CRUD
The Web API permits a variety of business functionality, but the principal mechanism of the API is to provide Create, Read, Update and Delete (CRUD) of database records and files.
The key entities available to recruiters are contacts (clients, candidates, client candidates), companies, requirements/vacancies, placements/jobs, timesheets, tasks and users with additional access to manage addresses, skills/attributes, lookups, types, e-mail, files, folders and much more.
For convenience, every API method uses the POST http verb. POST allows the API to accept parameters and to return complex data sets. Each API method is also stateless i.e. the coud services process each request separately allowing for scalability. API consumers must therefore accumulate the relevant security keys and pass these in as headers to each subsequent API call.
Structure of API
The API is broken down in to 'namespaces' or collections of categories of functions. The names of the API 'controllers' are self explanatory and should allow web/mobile designers and developers to easily find the relevant methods and properties.
This documentation also makes use of the live and secure Web API by including actual source code demonstrating how to access the Web API and perform CRUD operations on test databases to help designers/developers quickly and efficiently build line of business recruitment functionality for their clients.
Where e-mail templates or other files are described, they usually refer to the G:\ drive. This is an internal secure location of each recruitment agencies folders and files and is normally accessed by TriSys for storage of files such as CV's, templates, configuration, documents etc..
Endpoint
TriSys operates a 24x7 endpoint for all cloud hosted customers:
TriSys Web API can also be hosted on-premise for customers who are running their own private cloud. This endpoint will be provided to partners on request.
The status of all of our on-line services can be viewed at https://www.trisys.co.uk/cloud-status
About Business Software Group
In 1994, Business Software Group set out to build and commercialize the most advanced recruitment software in the market, with a view to establishing itself as the market leader.
On the road to achieving this goal, TriSys pioneered Windows-based recruitment agency software and was also the first software provider globally to offer cloud-based virtual desktop infrastructures for recruitment agencies, becoming a top-level certified Partner with Microsoft, Amazon and Google.
Currently TriSys is a leader in the recruitment software industry, offering on-premise and cloud-hosted recruitment software based on proven technologies. TriSys recruitment software is used extensively across desktops, browsers and mobile devices.
TriSys recruitment software offers maximum uptime, security, reliability and productivity for recruitment agencies looking to succeed at what they do best.
With TriSys recruitment agency software you are guaranteed to benefit from a solution which is used by hundreds of successful recruitment agencies globally, who all benefit from a highly innovative and simple to use recruitment software.
Business Software Group has achieved the status of certified Microsoft Partner, Amazon Certified Partner and Google certified Partner. Our innovative software uses only best of breed technology and integrates with the top recruitment industry services, offering you the absolute best value for money.
Business Software Group is a UK based private company headquartered in Cambridge, England.
Contact Us
Business Software Group
Nine Hills Road
Cambridge
CB2 1GE
United Kingdom
Legal Notices
Scope
This legal notice is specific to the TriSys Web API and TriSys cloud services ("API") and overrides any other privacy policy or legal notice appearing elsewhere on all Business Software Group websites. By using the API, you are agreeing to the practices set out in this statement.
You may access certain parts of this website without registering or providing Business Software Group with your details.
As the information on the API may be incomplete, out of date or inaccurate and may contain technical inaccuracies or typographical errors, we reserve the right to update the API at our sole discretion. Thus, such information may be changed or updated without notice.
Disclaimer
Business Software Group makes no warranties or representations of any kind concerning the accuracy or suitability of the API for any purpose. All such information and software are provided "as is" and with specific disclaimer of any warranties of merchantability, fitness for purpose, title and/or non-infringement. Business Software Group makes no warranties or representations of any kind that the API services or documentation provided on this website will be uninterrupted, error-free or that the API or cloud services are free from viruses or other forms of harmful computer code. In no event shall Business Software Group, its employees or agents be liable for any direct, indirect or consequential damages resulting from the use of the API.
Login Credentials
Where you have been provided with API keys, codes, login names, e-mail addresses or passwords, you agree not to make these credentials available to anyone. If there has been a disclosure of your or any demonstration credentials, you agree to promptly notify us of such disclosure so that Business Software Group can take appropriate security measures.
Intellectual Property Rights
Business Software Group is the owner of all intellectual property rights in the API, the material published on this web site and its software and data held in the Business Software Group cloud. Those works are protected by copyright laws and treaties around the world. All such rights are reserved.
You may print off one copy, and may download extracts, of any page(s) from the API for personal reference and you may draw the attention of others within your organisation to material posted on this website.
You must not modify the paper or digital copies of any materials you have printed off or downloaded in any way.
You must not use any part of the materials on the API or documentation for commercial purposes without obtaining a licence to do so from us.
If you print off, copy or download any part of the API documentation in breach of this Legal notice, your right to use the API will cease immediately and you must, at our option, return or destroy any copies of the materials you have made.
Any names of products or services provided by Business Software Group and referred to on this website are either trademarks or registered trademarks of Business Software Group.
However, the API documentation may include some words which have or are asserted to have proprietary status as trade marks or otherwise. Their inclusion does not imply that they have acquired for legal purposes a non-proprietary or general significance nor any other judgement concerning their legal status. In cases where the editorial staff have some evidence that a word has proprietary status this is indicated in the entry for that word but no judgement concerning the legal status of such words is made or implied thereby.
Service Access
Whilst we endeavour to ensure that the API and cloud services are normally available 24 hours a day, we shall not be liable if for any reason the API is unavailable at any time or for any period. Access to the API may be suspended temporarily and without notice in the case of system failure, maintenance or repair or for reasons beyond our control.
Global Nature of Web API
You recognise the global nature of the API and thus, agree to comply with all applicable local laws in your jurisdiction when using the API.
Information published on this website may contain references or cross-references to our services and/or products offered that are not announced or available in your country. Such references do not imply that we intend to announce such services and/or products in your country.
Governing Law
You agree that this Legal Notice shall be exclusively governed in accordance with the laws of and the courts in England and Wales. Notwithstanding the foregoing, nothing in this legal notice will preclude Business Software Group from applying to any court to bring an action for the infringement of its intellectual property rights.