Getting Started with Rently Partner API

Welcome to the Rently Partner API documentation. This guide will help you integrate Rently's rental management capabilities into your application.

Prerequisites

A Rently Partner account (will be provided by Rently)
API credentials (client ID and secret)

Welcome to our API integration guide. This document provides step-by-step instructions for integrating with our APIs.

Environments

EnvironmentName	Base Url
Test	https://partner-api.test.rently.sg
Production	https://partner-api.rently.sg

Step 1: Obtain an Access Token

To interact with our APIs, you must first obtain an access token using your clientId and clientSecret.

Token Endpoint

POST https://{base.server.url}/api/v1/token

Request Headers

Header	Value
Content-Type	application/json
X-RENTLY-PARTNER-ID	{partnerId}

Request Body

Parameter	Description
clientId	Your client ID
clientSecret	Your client secret

Example Request

POST https://{base.server.url}/api/v1/token
Content-Type: application/json
X-RENTLY-PARTNER-ID: 60db2ea0-f828-4b41-81ae-05eeb68ca5d1

{
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "clientSecret": "secret"
}

Example Response

{
  "accessToken": "eyJhbGciOiJFUzI1NiIsImtpZCI6InJlbnRseV9zaWdfMjAyMjA1MDciLCJ0eXAiOiJKV1QifQ.eyJzdWIiOiI2MGRiMmVhMC1mODI4LTRiNDEtODFhZS0wNWVl...",
  "expiresIn": 3600,
  "tokenType": "Bearer"
}

Step 2: Call the API

Once you have obtained the access token, include it in the Authorization header of your API requests.

API Endpoint

GET https://{base.server.url}/api/v1/resource

Request Headers

Header	Value
Authorization	Bearer your-access-token

Example Request

GET https://{base.server.url}/api/v1/resource
Authorization: Bearer your-access-token

Example Response

{
  "data": "response data"
}

Notes

Replace clientId, clientSecret, partnerId and your-access-token with actual values.
Tokens are valid for 1 hour. Reauthenticate as needed to obtain a new token.

For further assistance, contact our support team.