Help Center
Go to Roolz appsupport@roolz.net
English
English
  • 👋Welcome
  • Getting Started
    • 💡What is Roolz?
    • 💰Plans and subscriptions
      • Can Roolz be used for free?
      • How to buy a subscription?
      • How to unsubscribe?
      • How to change a subscription plan?
      • How are subscription fees calculated?
      • What does it mean to say «the total company limit is formed from the sum of the limits per user»?
      • What are credits and how to buy them?
  • 🌟How we are different?
  • 🎯Our values
  • Registration and Login
    • PC registration
    • Mobile registration
    • Registration via the invitation link
    • Login
    • How to change login method
  • User profile
    • What is a user profile?
      • Which optional info can you add in your profile?
      • How to change user profile information?
  • Contacts and people search
    • My contacts
    • People search
  • Companies
    • Company creation
      • How to add/change details about your company profile?
    • Company profile
      • Completed company profile
      • Can we make a private company public?
      • Private and public profiles: what's the difference?
    • Inviting colleagues and the roles
  • Switching company spaces
  • Company verification
  • Working in the company space
  • Company directory
    • All you need to know
      • The information displayed in the profile
      • Criteria for searching companies in the directory
      • How to promote your company in the directory
  • EXCHANGE AND OFFERS: FREIGHT AND TRANSPORT MARKET
    • Public vs private exchange: the difference
  • Vehicle search
  • Freight search
  • Automatic matching of freight and transport offers
  • Freight offers
    • Bidding modes for freight offers
  • Vehicle offers
  • Offers: editing, activity and statuses
    • How to create offer templates?
    • How to delete or edit an offer?
    • How to publish an offer as an individual if I have a company?
    • How to respond to an offer?
    • How to receive notifications about responses to my offer?
    • What are the offer statuses?
  • Offers: managing and exporting to EXCEL, CSV, JSON
  • Private exchange: partnerships
  • Private exchange: sending offers
  • BIDS
    • Placing bids
  • "Bargain" bidding mode
  • "Auction" bidding mode
  • Bid's privacy
  • MESSENGER
    • Full guide
      • Chat types and what you can do with them
      • How do I know if someone read my message?
      • Blocking users and blacklist
  • READY INTEGRATIONS
    • 🤝SpotGo
  • OPEN API
    • Introduction
    • Offers
    • Company
    • System
    • Field values
      • Company
        • Role in logistics | exchange_role
        • Number of shipments per month | order_amount
        • Types of cargo and packaging | cargo_type
        • Company types | company_form
        • Customs services | customs_service
        • Number of employees | employee_amount
        • Fleet size | fleet_amount
        • Logistics services | logistics_service
        • Types of transportation | transportation_type
        • Associations | associations
      • Offers
        • Types of cargo and packaging | cargo_types
        • Shipping modes | shipping_modes
        • Vehicle categories | transport_types
        • Truck body types | truck_bodies
        • Options and truck body features | extra_equipment
        • Loading/unloading methods | loading_types
        • Waypoint types | point_types
        • Payment terms | payment_cond
        • Payment methods | payment_methods
        • Reasons for removing offer from publication | publ_autocancel_reasons
Powered by GitBook
On this page
  • Test Environment
  • Getting an API Key
  • Switching environment from Test to Production

Was this helpful?

Export as PDF
  1. OPEN API

Introduction

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

PreviousSpotGoNextOffers

Last updated 26 days ago

Was this helpful?

Test Environment

To begin integration and test your requests, you’ll need to create a company account in our test environment: .

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 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.

test.roolz.tech
technical support team