> For the complete documentation index, see [llms.txt](https://help.roolz.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.roolz.net/en/open-api/introduction.md).

# Introduction

Welcome! This documentation and our public API will help you integrate your internal systems with our freight exchange platform.

### Test Environment

To begin integration and test your requests, you’ll need to create a company account in our test environment: [test.roolz.tech](https://test.roolz.tech).

### Getting an API Key

To start working with our public API, you need to generate an API key, which will be used to authorize requests within our system. Follow these steps:

1. Open **"Management"** section at the top right of Roolz exchange.
2. In the pop-up window titled **"Company Account"**, click **"API Key: Yes, generate"**.
3. Copy your company’s API key and use it to enable integration.

### Switching environment from Test to Production

Once you completed and configured your integration in our test environment, please contact our [technical support team](mailto:support@roolz.net) to receive access credentials for the production server. After that, you’ll be able to generate an API key on the main platform and then, by using the server address provided by the support, to fully activate your integration with Roolz.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.roolz.net/en/open-api/introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.