Cobra API instruction

You will find the possibility to create and manage a Cobra API client in the management menu in the tile Cobra services.

After you have clicked on the Cobra API service in the selector, go to the Roles tab. Here it is possible to change existing API clients or add new ones.

• Press the Add Cobra API client button

• Enter a name for the client. This is free text, so that it is clear to you for what purpose you are creating this client.

• The start and end date are optional. This allows the access of a client to be set time-dependent.

• Press the Create Client secret button

• In the screen you will now see the Client-Identifier (login name) and a Client Secret (password). With the copy buttons you can copy this and then pass it on to the person who will create the API link for you.

Please note: the Client Secret in the screen is NOT stored by us for privacy reasons. So don't forget to copy this before you click Save.

NB: the Client Identifier can still be seen after saving.

• Now determine to which endpoints and methods the client should be authorized. Please note: you only need the endpoints listed below from the GET column:

• Press Save

Example:

By clicking on the pencil next to an existing client, you can determine the authorization of what the API user can request, add, change or delete. A collection of data is called an "endpoint" in the API, for example the endpont Address contains all address data that you register in Cobra. The methods GET, POST, PUT, PATCH and DELETE indicate whether you can consult, add, change or delete the address data.

Not all endpoints know all methods, for example it is not possible to add calculated data (CalculatedSalaryComponent) from an external application in Cobra. The wage calculation is done by Cobra itself, so this data can only be requested.

In the context of the GDPR legislation, it is important that you only make those data accessible that are necessary for the relevant link (purpose).

For existing clients, we have enabled all endpoints and methods for you. After all, we cannot determine which data is or is not important.

So check your existing API accounts and adjust the authorization if necessary!

Note: when changing an existing client, it is NOT recommended to click the Create client secret button! An API account consists of a Client Identifier (login name) and a Client Secret (password). When you click the button, a new password will be created and an existing application will no longer work.

In case you consciously DO want to change the password, press this button and DO NOT forget to click Save. Otherwise, the new password will not be implemented yet.

If the task described above does not work, it means that you have not yet purchased the Cobra API service. This is an extra module in our service for which additional costs are charged.

If you want to use this, press the Email SD Worx button to activate Cobra API., Fill in your details and press Send. The SD Worx account manager will then contact you as soon as possible.