Overview and Prerequisites
An overview of the R1 Discover API and what you need to get started
The R1 Discover API allows you to programmatically interact with our platform, enabling you to automate processes, integrate systems, and create a personalized experience for your users. Whether you're looking to embed our resources into your service, retrieve analytical data, or manage user settings, our API provides the necessary tools to do so efficiently and effectively.
Base URL and Authentication Overview
Base URL: https://api.r1learning.com
Open API Docs: https://api.r1learning.com/docs
All API requests should be made to the base URL provided above. This URL serves as the gateway to the R1 Discover services, ensuring secure and reliable access to our data endpoints.
Authentication
All interactions with the R1 Discover API require authentication to ensure data privacy and security. We employ a token-based authentication system, specifically using Bearer tokens, to manage access to our API. You must include an authentication token in the header of every request you make to our API endpoints.
Prerequisites
Before you begin interacting with the R1 Discover API, there are several prerequisites you need to meet:
Tech Partner API Account: You must request a Tech Partner API account from the R1 Discover team. The account is necessary for generating your Bearer token.
Bearer token: It is required to have an authentication (Bearer) token in the header of every request made to our API endpoints. The token can be generated through your Tech Partner API account..
Account Setup: Ensure your R1 Discover account is set up with the correct permissions to access the necessary data endpoints. If you encounter any permission issues, please contact our support team.
Familiarity with RESTful APIs: Basic knowledge of RESTful principles and HTTP methods (GET, POST, PUT, DELETE) will help you integrate more seamlessly.
Postman Setup (Optional): For a more interactive experience and to facilitate testing during integration, we recommend setting up Postman, an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster. We provide a ready-to-use Postman collection that you can import to test our endpoints effortlessly. This setup is not required but highly recommended to enhance your development process.
By the end of this documentation, you should be equipped with all the information needed to successfully integrate and utilize the R1 Discover API. Let's build something amazing together.
For detailed guidance on each endpoint, including parameter descriptions and example requests and responses, proceed to the subsequent sections of this documentation.
Last updated