API Documentation
API Documentation
Introduction
Overview
Getting started
🔑 Authentication
Requesting temporary credentials
Signing requests
🎬 Entities
Entity types
The entity object
Amount
Catalog item
Contact
Deal
File
Financial document
Inventory
Job
Rightset
Table
👬 Relationships
The relationship object
Relationship types
Create a relationship
Delete a relationship
🔎 Search
Entity search
Relationship search
Pagination
Search Functions
Search Examples
🧰 Workflow
Execute a workflow action
📆 Date Math
Overview
The date math object
Create date math
Retrieve date math
Update date math
Delete date math
🧮 AVAILS
Overview
Get dimension data
Get availability
Is catalog item available
Swagger
Message queue docs
Rightsline.com
Powered by GitBook

Getting started

Get started sending requests to the Rightsline API.

Obtaining API Credentials

The three elements you will now need to make a request in API Version 3 are: Company API Key, Rightsline Access Key, and Rightsline Secret Access Key. The Company API Key is shared among your organization and is unique per environment (Staging, Integration, Prod Mirror, and Production). Your Access Key and Secret Access Key is unique for your API User account. It will inherit the security policy that is attached to your account.

  1. Contact your Rightsline representative to receive your Company API Key.

  2. Login to your user account from https://admin.rightsline.com.

  3. Open your Profile from the drop-down menu, and in the API Access module, click Generate Access Keys.

Generate your Access and Secret Keys.

You will use these keys to request temporary access keys to authenticate to the API. These keys are private. Please store them securely.

Once you have your Company API Key, and your User Account's Access and Secret Key, you are ready to make your first API request.

Previous
Other references
Next - 🔑 Authentication
Requesting temporary credentials
Last updated 6 months ago