About the Copernica category

o.plokha · January 7, 2026, 8:39am

Put topics about this connector package here.
Always check the ‘How to use the Alumio connector packages’ topic.

Extra information

System documentation: Copernica API Reference

Connector package documentation

1. Setting up HTTP Client

1.1 Steps

In the Alumio Dashboard, go to Clients → HTTP Clients. Create a new HTTP Client.
Select Copernica HTTP Client as Platform and click Next Step
Fill in the Base URL, Authentication JWT URL, and the Access token.
You can optionally enable logging of requests to get the log of the HTTP requests.
Click next step, fill in the name of the HTTP Client, and finally, you can save the HTTP Client for use.

2. Subscribing to Entities from Copernica

2.1 Steps

Go to Connections → Incoming and create a new incoming configuration and select “Copernica Subscriber” as the subscriber.
Select the Copernica HTTP Client to use.
Select the entity you want to subscribe to from Copernica.
Add any request parameters needed to subscribe to the entity.
You can optionally add a transformer to transform the request parameters into something you will request from Copernica.
You can also optionally enable pagination to allow Alumio to fetch paginated entities.

2.2 General Concept
We follow the Copernica documentation on building this connector, so you can easily use the connector based on Copernica API Reference.

Entity
The entity you want to subscribe to Copernica. Please refer to the entities from Copernica API Reference page.

Request Parameters
You can provide these parameters to get the needed entity based on the Copernica API Reference.

Please look at the example below on how to fetch all profiles from the specific database by subscribing to the “Database & Collections - fetch all profiles” entity.

From the endpoint, we can see that we need to set the database id as a parameter. That is why we set the “id” inside the path key in the Request Parameters.

Alumio will then make a request to Copernica with the URL https://api.copernica.com/v4/database/{{id}}/collections

Path is the path parameter of the URL. For example, the {id}.
A query is a 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 Copernica.

3.1 Steps

Go to Connections → Outgoing, create a new outgoing configuration, and select “Copernica Publisher” as the publisher.
Select the HTTP Client to use.
Select the Method you want the publisher to use with the data.
Select the entity you want the data to be published to.
You can optionally add any query data to the request on the key query.
You can optionally add any payload data to the request on the key payload.

3.2 General Concept
Like the subscriber, the publisher has similar methods for using 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 the payload using the Request Transformer.

Method
Currently, we support the HTTP Post, Put, and Delete method on submitting data to Copernica.

Entity
We support publishing to all Copernica endpoints.
Please refer to the Copernica API Reference

For example, we want to update a profile. Please select “Put” as the Method and “Profile & Subprofile - Update the profile information”.

From the documentation, we can see that we need to set a path parameter and a body parameter. That is why we set the “id” as a profile ID inside the path key and body parameters inside the payload key in the data.

Alumio will send an API request to Copernica with URL PUT https://api.copernica.com/v4/profile/$id with the defined payload.

Path is the path parameter of the URL. For example the {ContainerId}.
Query is a 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.