- SOAP API is an interface, and it must be activated in order to view and use the features described below.
- A web service is a type of API that is hosted remotely and offered as a service through the Internet. For more information about web services, please refer to Wikipedia: Web service.
- Details of the Severa SOAP API in the WSDL.
- Severa SOAP API documentation can be found at: https://sync.severa.com/webservice/S3/apidocs.
In brief
Severa's SOAP API is a web service API that allows you to program an interface between Severa and other software applications. Code written by your IT programmer for the API will process a request, retrieve data and transmit it for use by one software or the other - in effect, the API acts as a shortcut to share data between software applications. For example, it’s possible to use the API to retrieve data from Severa, about employees’ work hours, for payroll software to generate monthly salary payments. The API may also be used the other way around, to insert data from another program into Severa.
In general, the use of SOAP API is controlled by only a few people, however the benefits of sharing data between applications may be visible to all Users depending on the type of data shared between the applications.
Getting Started
First, it's important to make sure that SOAP API will meet the needs of your company. Review the WSDL with your company's programmers and discuss the possibilities.
SOAP API is activated through Settings > Upgrades > Adjust features. Click Interfaces, select SOAP API, and click Next to advance to the Agreement page. Review details on the Agreement page, and Confirm agreement.
Click here for more details and instructions (English only).
Permissions
Once activated, the Administrator must grant permissions for the specific users to control the API. To do this, navigate to Settings > User management. Open the user for editing, and go to Permissions > SOAP API and select Allowed.
Data retrieved and sent using the API is limited according to the permissions of the user.
Enable/Disable API
After a user has been granted access to the API a new section will be visible on their own profile.
To disable the API, click your name on the top right corner, and select My profile. Move to SOAP API section, and disable it from there.
Did you find it helpful? Yes No
Send feedback