SOAP API is a webservice API. This means that the API is available in 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 to Severa, an API key is required. Without it, it is not possible to use the API. So even the API itself is public, the use of it is limited for the organizations which have Severa's API addon active, and that have generated an API key and taken it to use in an integration software.
Shortly the steps to integrate are:
- Define needs for integration. Is it needed for example to insert work hours or transfer invoices?
- See if SOAP API has the needed interfaces and options for the integration. Use API documentation together with Severa environment to gain this knowledge.
- If you are integrating with another software, check also that other end has a API or some other way for wanted interaction.
- If everything seems good, build a software that connects to 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 API to perform an action, and wait for the response from API to see if it was successful.
- Click here for more details and instructions (English only).
To be able to integrate to Severa, it is needed to set up API in your Severa organization.
- It is recommended to create one API user to Severa, which isn't any employee of the organization in question. This is because of two reasons:
- It is needed to give API key to an user who has wide access rights to Severa, because it is important to get correct data out to your software. All data that is gotten from API is limited by the access rights of the user whose API key is in use.
- When 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, API user needs to be active all the time, so if API key is generated to some employee, integration won't work when user is inactivated.
- When API user has been created and API activated, 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 API key is regenerated for the user in question, API key needs to be updated in the software which is integrating to Severa.
Did you find it helpful?Send feedback