Protime

​

Extra information

System documentation: Protime API Reference

​

Connector package documentation

​

Table of Contents

• 1. Setting up HTTP Client Protime
  • 1.1 Steps
• 2. Subscribing to entities from Protime
  • 2.1 Steps
  • 2.2 General concept
• 3. Publishing entity to Protime
  • 3.1 Steps
  • 3.2 General concept

​

1. Setting up HTTP Client Protime

1.1 Steps

1. In the Alumio Dashboard, go to Clients -> HTTP Clients. Create a new HTTP Client.
2. Select Protime HTTP Client as PlatForm and click next step
3. Fill in the Base URI, Access token URL, ClientID, ClientSecret and enter the required scopes. (See the Protime Authentication Documentation for more information)
4. You can optionally enable logging of request to get the log of the authentication.
5. Click next step, fill the name of the HTTP Client and finally you can save the HTTP Client for use.

​

2. Subscribing to Entities from Protime

2.1 Steps

1. Go to Connections -> Incoming and create a new incoming configuration and select “Protime Subscriber” as the subscriber.
2. Select the entity you want to subscribe to from Protime.
3. Add any request parameters needed to subscribe to the entity.
4. Select the Protime HTTP Client to use.
5. You can optionally add a transformer to transform the request parameters into something you will request from Protime.
6. You can also optionally enable pagination to allow Alumio fetches paginated entities.

2.2 General Concept We follow Protime documentation on building this connector, so you can easily use the connector based on Protime API Reference. Entity The entity you want to subscribe to Protime. Please refer to the entities from Protime API Swagger page. Request Parameters These are the parameters you can provide to get the needed entity based on the Protime API Swagger. Please look at the example below on how to fill request parameters when we want retrieve an administration debtors by subscribing “Get a list of clockings” entity. From the documentation page, we can see that we need to set the query parameters. In this case we insert it into “Request parameters” input. Alumio will then make a request to Protime with the URL /connector/protimeapi/api/v1/clockings?filter=date+ge+%272025-01-01%27+and+date+le+%272025-07-05%27

• Path is the path parameter of the url. For example /connector/protimeapi/api/v1/clockings/{id}.
• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0

HTTP Client The HTTP Client configuration you will use to access Protime.

​

3. Publishing Entity to Protime

3.1 Steps

1. Go to Connections -> Outgoing, create a new outgoing configuration and select “Protime Publisher” as the publisher.
2. Select the Method that you want the publisher to perform with the data.
3. Select the Protime entity you want the data to be published to.
4. You can optionally add any query data to the request on the key query.
5. You can optionally add any payload data to the request on the key payload.
6. Select the HTTP Client to use.

3.2 General Concept Like the subscriber, the publisher has similar methods on how to use it. The difference is the payload that will be submitted by the publisher originating from the data (from routes, from transformers in outgoing configuration), though you can also add or modify payload using the Request Transformer. Method Currently, we support HTTP Post, Put and Delete method for submitting data to Protime. Entity We support publishing to all Protime endpoints. Please refer to Protime API Reference page. For example, we want to create a new clockings. Please select “Post” as the Method and “Add a clocking”. From the documentation, we can see that we need to set a body parameters. That is why we set the body parameters inside the payload key in the data. Alumio will send an API request to Protime with URL POST /connector/protimeapi/api/v1/clockings

• Query is defined set of parameters attached to the end of a url.
  Example: www.url.com?type=true&start=0
• Payload is the data contained within a request.

HTTP Client The HTTP Client configuration you will use to access Protime.