In Sorwe, an API key enables the platform to securely exchange data with other systems. For example, when companies want to integrate Sorwe with their internal systems to enable data sharing, the API key ensures that this communication is carried out securely.
You can generate APIs in the system for multiple use cases. One common example in Sorwe is updating employee records. If employee data in your company is frequently updated (such as promotions, department changes, or new hires), instead of transferring this information manually to Sorwe each time, you can create an API connection to have the data updated automatically.
So, how can you create an API key from the Sorwe Connect Admin panel?
Go to Settings > Account in the lower left corner of the panel, then click Developer Settings on the screen that appears.
Click the Create API Key button on the screen that appears.
You can give your API a name.
You can define the duration.
You can select the scopes.
Finally, click the Create API Key button.
A pop-up window will display your API key and secret. You can download this information. Please note that once you close this window, you will not be able to view these details again.
On this page, you can view all API keys you have created.
You can:
Create a new API
Update an existing API
Or remove an API
whenever needed.
PUBLIC API
After creating your API Key, you can review the Sorwe API documentation using the link provided at the top of the page.
This link directs you to Sorwe’s API documentation. On this page, you can find detailed information about how to integrate Sorwe’s API with your own application. The documentation typically includes the following details:
API Endpoints: The available API endpoints provided by Sorwe and what each of them is used for (for example, retrieving employee data).
Authorization: How to use the API key and how to securely access Sorwe’s API with this key.
Request and Response Formats: The structure of the requests sent to the API (e.g. sending data in JSON format) and how the responses are returned.
Sample Requests: Examples of API requests in different programming languages or tools to help you set up the integration quickly.
In summary, this link serves as a guide for developers who want to use the Sorwe API. It explains how the API works, what kind of data it provides, and how integration processes can be carried out.