API

We distinguish two types of integrations: a custom integration and a marketplace integration. A custom integration is built for one specific customer to support a customer-specific process. A marketplace integration is a standard integration that is made available to all Robaws customers in the Robaws integration marketplace. The difference between the two lies in the authentication method. The requirements for a marketplace integration are slightly stricter.

Updates

See the API changelog

Reference documentation

https://app.robaws.com/swagger-ui/index.html

Your API integration should take into account the Robaws rate limiting response headers. HTTP 429 errors will be monitored. If they occur too often, Robaws team will intervene to temporarily block the integration until you provide a solution. More details about the rate limiting can be found in the reference documentation.

I want to build a custom integration

For custom integrations, HTTP Basic Authentication is the recommended authentication method. We recommend you to create a separate user in the customers' Robaws environment. If you check the box 'API only', the user is free of charge. It is considered a best practice to create a separate role for that user, granting only access to the modules needed by the integration.

I want to build a marketplace integration

For marketplace integrations, the OAuth2 Authorization Code flow is the required authentication method. The requirements are:

You do not refresh access tokens until they are (almost) expired.
You build the integration against a Robaws test tenant first.
In order for your integration to become available for production (in the Robaws marketplace), a demo video will be required where you demonstrate the integration.
You'll need to provide us with an URL to the page where the customer can initiate the OAuth2 flow at your side.
Polling is discouraged! If your integration should be aware of a change that happened, you should use the webhooks.

Getting started

Test tenants can be provided free of charge for 14 days. If needed this period can be extended.
For a marketplace integration, you'll need an OAuth2 client ID & client secret.
Contact us on [email protected] to get started.

Topics

Webhooks
Request idempotency
API rate limiting
API filtering, paging & sorting
Updating information (PUT vs PATCH)
Uploading files

Example use cases

Creating a work order
Synchronizing article data with your own database
Creating a client/lead from a website form
How to fetch invoices for import into accountancy software?

Bijgewerkt op: 08/02/2024