Guides for the Rillsoft Integration Server

Guides for the Rillsoft Integration Server

This section bundles the practical steps around the Rillsoft Integration Server: from the first setup, through authentication, to migrating existing SOAP integrations to today’s REST API v2.

Installing the Integration Server

The Integration Server runs as a Linux service. Two distributions are covered directly today:

• Installation on Debian – recommended for current server setups.
• Installation on CentOS – for existing RHEL/CentOS infrastructures.

After a successful installation, the REST API is available at the configured base URL (example: https://app.rillsoft.cloud).

Authenticating with the REST API

The API uses Bearer tokens exclusively. Typical flow:

1. Log in with POST /api/v2/login using username and password.
2. Send the returned token in the Authorization header of subsequent calls: Authorization: Bearer <token>.
3. Rotate or refresh the token before it expires.

Details on all schemas and required fields live in the API Reference.

Migrating from the SOAP web service to REST API v2

If you still rely on the older SOAP web service in production, plan the switch alongside your move to Rillsoft Project 10 – the release that rebuilt the entire integration layer on REST and shipped it as API v2. Recommended order:

1. Inventory current SOAP calls – which operations, which fields, which data volumes.
2. Map to REST endpoints – use the API v2 reference as the source of truth.
3. Switch authentication – WS-Security is gone; use the Bearer-token flow instead.
4. Review the JSON data model – field names, date and UUID formats differ from the old XML schema in places.
5. Migrate incrementally – v1 stays available in parallel; build new connections directly on v2.

Typical integration scenarios

• ERP integration: regularly sync master data (employees, projects, customers).
• HR integration: reconcile vacations and absences between the HR system and Rillsoft Project.
• BI / reporting: pipe aggregated data from the dashboard endpoints into Tableau, Power BI, or Looker.
• DMS integration: automatically attach documents from third-party systems to projects or tasks.
• Custom web or mobile clients: lean front-ends without fat-client installation.

Planned additions

• Step-by-step example workflows (Postman, cURL).
• Reference implementations in Python, Java, and .NET.
• Notes on rate limits, pagination, and error handling.
• A practical guide to migrating individual SOAP operations to REST.