Get Started with Alasco Public API

Welcome to the Alasco Public API! You can use it to integrate your application with Alasco and supercharge your business processes. It is REST-based and follows JSON:API principles for structuring responses.

API Stability

Starting with version 1.0, the API is stable. We are continuously improving our API and new capabilities are added all the time. Any updates or changes within a major version are backward-compatible and can be found in the change log.

Authorisation

The Alasco Public API uses a combination of key and token to authenticate requests. Any account administrator can create a key/token pair within Alasco if the account is activated for public API access. To get access, contact your Alasco account manager or [email protected].

  • API Key: header parameter X-API-KEY
  • API Token: header parameter X-API-TOKEN

Rate Limits

At Alasco, we're committed to offering high performance and reliability. To ensure that, we’ve set sensible rate limits on the API endpoints. These limits are designed to be generous enough to support most use cases; if you ever hit the limits or know you will generate a lot of requests, please contact us!

URL Encoding

When using our API, make sure to encode any parameters that might contain special characters (like spaces or symbols). Without proper encoding, these characters can break the request or lead to unexpected behaviour. A simple rule: if you wouldn’t type it directly into a browser URL, make sure it’s encoded. Most programming languages have built-in functions to handle this, so it’s an easy fix!

Example:
Hunsrück Mitte → Hunsr%C3%BCck%20Mitte

Trailing Slashes

Please make sure to use trailing slashes when calling our endpoints. While most endpoints work fine without them, some do not. It depends on whether your client follows redirects (e.g. status code 307) or not. Our documentation always contains them, so if you copy & paste from here, you should be fine!

Example:
Instead of /contractors use /contractors/