Rently API overview
The Rently API is a REST API that lets you integrate external systems with the vehicle rental management platform: searching availability and quoting, creating and managing bookings, recording payments, operating deliveries and returns, and managing customers, fleet, incidents and infractions.
This page is the entry map to the reference: it summarizes the essentials (base URL, authentication, languages) and describes each API module along with its purpose.
Base URL
All calls are made over HTTPS against:
https://{tenant}.rently.com.ar
Business endpoints live under /api (for example GET /api/search).
Rently is multi-tenant. Your integration always operates against your tenant's host, which identifies the organization and to which the access token is bound.
Authentication
The API uses OAuth2 with Bearer tokens: you request a token with your credentials
and send it in the Authorization: Bearer {token} header on every request.
# 1. Obtain the token (client_credentials)
curl -X POST https://{tenant}.rently.com.ar/auth/token \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "grant_type=client_credentials" \
-d "client_id={username}" \
-d "client_secret={password}"
The response includes access_token, token_type (bearer) and expires_in
(the token is valid for one day). Use that token in subsequent calls:
# 2. Call an endpoint with the token
curl https://{tenant}.rently.com.ar/api/branchoffices \
-H "Authorization: Bearer {token}"
Reuse the same token until it expires instead of requesting a new one on every
call. If the token is missing, expired or does not match the tenant, the API
responds 401 indicating the token endpoint URL in WWW-Authenticate.
Languages
The API resolves the response language per request. To force a specific
language, add the ?language= query parameter (it accepts the full culture
name, e.g. es-AR, or the two-letter ISO code, e.g. es):
curl "https://{tenant}.rently.com.ar/api/categories?language=es-AR" \
-H "Authorization: Bearer {token}"
If not specified, the user's language is used, then the tenant's default
language and, as a last resort, es-AR. The available languages depend on each
tenant's configuration; you can query them with GET /api/languages and
GET /api/languages-info.
The ?language= parameter only takes effect on API requests; values not
supported by the tenant are ignored and the default precedence is applied.
Postman and other clients
You can import the entire API into Postman, Insomnia, Bruno or Hoppscotch:
- OpenAPI specification (any client): download
openapi.json - Postman collection (ready to use): download
rently-api.postman_collection.json
In Postman: choose Import and drop the file; it creates the collection with all the endpoints. Set the tenant variable and your Bearer token to start testing.
In Insomnia / Bruno / Hoppscotch: import the openapi.json directly.
Modules
The API is organized into modules. Each one groups the endpoints of a functional area; see the detail of each operation (method, path, parameters and examples) in the reference.
| Module | Purpose |
|---|---|
| PublicApi | Availability search and quoting: GET /api/search, GET /api/booking/price and GET /api/booking/additionals-price. |
| GeneralInformation | Catalogs and master data: branch offices, pickup/return places, categories and models, additionals, currencies, promotions, holidays, attention schedules and languages. |
| Bookings | Booking lifecycle: create (POST /api/booking/book), reserve (POST /api/booking/reserve), query (GET /api/booking/{bookingId}), cancel, list and manage drivers, comments and files. |
| BookingsPayments | Booking payments: record a payment (POST /api/booking/pay), list a booking's payments and cancel a payment. |
| CustomersApi | Customer management: list (paginated), create/update, query by ID or globalId, payment methods, comments, attachments and document images. |
| Cars | Fleet queries: get a car, list cars with filters, view their bookings, relocate/transfer between branch offices and manage files. |
| Operations | Back-office operations: deliveries and returns scheduled by branch office and date, and processing a booking's delivery/pre-delivery and pre-return. |
| BookingCheckinApi | Customer self check-in before delivery (PUT /api/selfcheckin). |
| Incidents | Vehicle incidents/claims: list types, record an incident and attach files to it. |
| Infractions | Traffic infractions: add to a booking (POST /api/booking/addinfractions), charge/pay, list a customer's infractions and attach the ticket. |
| Services | Vehicle services and maintenance: service types and service scheduling for a car. |
| Notifications | Email notifications: list active templates and send notifications using a template. |
| Configurations | Tenant configuration: document and tax payer types, booking and email config, payment gateways and accounts, and general settings. |
| CommercialAgreements | Commercial agreements applicable to price calculation. |
| Storage | Web file management. |
For a typical quoting and booking integration, start with PublicApi and GeneralInformation (catalog + search + price), continue with Bookings and BookingsPayments (create and pay), and add Operations for delivery and return.
Errors and pagination
Business errors respond 400 with a JSON body
{ "ErrorMessage": "...", "ErrorCode": 1, "Id": "..." }, where ErrorCode is an
integer and Id is a correlation identifier useful for support. The
403 (not authenticated or no permissions) and 404 (resource not found)
responses include no body.
Listings use pagination with the offset (default
0) and limit (default 30, maximum 100) query parameters, and return an object with
Offset, Limit, Total, Results and NextOffset. To move to the next page,
use the NextOffset from the previous response as offset.