R1 API: Getting Started
An overview of getting started with the R1 API.
Welcome to the R1 Discover API! This section is designed to help you quickly start integrating our API into your applications. Follow these steps to ensure you have everything set up correctly.
Prerequisites Recap
Before diving into the API details, let's ensure you have everything needed:
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.
Step-by-Step Setup
Step 1: Obtain a Tech Partner API Account
To access the R1 Discover API, you first need an R1 Discover Tech Partner API account:
If you don't a Tech Partner API account, contact your R1 Learning primary point of contact, or reach directly to our support team.
Upon creation of your account, you receive an email with the instructions and credentials to login to your account. You will have to accept the terms and conditions & change your password to finalize setting up your account. For detailed instructions on how to do this, see My First Login.
Once your account is setup, login to your account and proceed to Step 2.
Step 2: Generate Your Bearer Token
With your R1 Discover Tech Partner API account, you can now generate a Bearer token which will authenticate your API requests. Follow these steps to generate your token:
Login to the R1 Discover Tech Partner API account
Select the API Tools tab on the left hand navigation
Select the Generate API Authentication Token button
Copy the token to a secure location, once leaving or navigating away from the page, the token will no longer be visible/available.
This token is required for every API call
Additional Notes
A new token can always be generated on the API Tools tab
Generating a new token will invalidate existing token
A log of each token generation will be visible on the API Tools tab
At a future date to determined, R1 Discover API may require a scheduled token refresh.
Step 3: Setup Postman (Optional)
To set up Postman for testing:
Download and install Postman from postman.com.
Simply click here to link to the Postman collection file.
Import the R1 Discover Postman Collection into postman.
Configure your environment variables in Postman to include the Bearer token you obtained.
Step 4: Make Your First API Call
Now that you have everything set up, try making your first API call to retrieve a list of available resources:
GET /api/v1/api-endpoints
Authorization: Bearer {your_bearer_token_here}Check the response to ensure you have set up everything correctly and are able to receive data from the R1 Discover API.
Support and Resources
If you encounter any issues during setup or have questions about the API, do not hesitate to contact our support team. Our team is eager to assist you and ensure your integration process is seamless.
By following these steps, you'll be ready to fully utilize the R1 Discover API to enhance your applications with our comprehensive suite of services. Happy coding!
Last updated