SOAP API is a webservice API. This means that the API is available on the internet, visible for anyone who wants to view it. The API is used by coding a software which connects to it and interacts with the API. To integrate with Severa, an API key is required. Without it, it is not possible to use the API. So even though the API itself is public, its use is limited to organizations that have Severa's API addon enabled and have generated and activated an API key in the integration program.

Briefly, the steps required for integration are:

  • Define needs for integration. Is it needed, for example, to insert work hours or transfer invoices?
  • Check if SOAP API has the needed interfaces and options for the integration. Use API documentation together with the Severa environment to gain the necessary information.
  • If you are integrating with another software, check also that the other end has an API or some other way for the desired interaction.
  • If everything seems good, build a software that connects to the API and performs the integration. Often there is a need to have a server where the integration is running. It is also recommended to monitor and log possible integration errors.
  • SOAP API is passive, which means that the integration software needs to call the API to perform an action and wait for the response from the API to see if it was successful.
  • Click here for more details and instructions (English only).

Setting up API for your organization

To be able to integrate with Severa, you need to enable the API in your Severa organization.

  • It is recommended to create one API user in Severa, who isn't any employee of the organization in question. This is because of two reasons:
    • It is needed to give the API key to a user who has wide access rights to Severa, because it is important to get correct data out to your software. All data that is obtained from the API is limited by the access rights of the user whose API key is in use.
    • When the API user is none of the organization's employees, there is less need to keep track of which user's API key is in use, and what are the access rights of that user, or is that user still working for the company. For integrations to work, the API user needs to be active all the time, so if the API key is generated for some employee, the integration won't work when the user is inactivated.
  • When the API user has been created and the API activated, an API key is generated for the user. This API key is used in the integration software, and it identifies the user who is making the API call, as well as the user's organization, ensuring that data is returned correctly.
  • If the API key is regenerated for the user in question, the API key needs to be updated in the software which is integrating with Severa.


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.