Working with the Clever API

Manual Queries with Clever API

The recommended method for making manual queries to the Clever API is by using Postman. The Clever API Developer Collection workspace in Postman offers a secure environment for making calls and troubleshooting issues. Access the Postman Workspace here.

📘

Security on Postman

To learn more about security on the Postman platform, see Postman Trust and Security.

Using the Workspace

To use the Postman workspace, follow these steps:

1. Create a Free Postman Account: Sign up for a free account on Postman.
2. Fork API Collections: Create a fork of each API collection you want to use (Data API, Events API, and Identity API).
   • For the Identity API, use a bearer access_token obtained via the Clever SSO login flow.
   • For the Data API, use a District-App token, except for endpoints accessible by Library applications which require a bearer access_token.
   • Enable the Events API in your application dashboard under Settings > Integration.

Forking a Collection

📘

Forking in Postman

To learn more about forking in Postman, see Forking Elements in Postman.

1. Fork Collections: After creating an account, click on the related actions (three dots) to the right of the collection you want to use. Select "Create a fork" and follow the prompts.

Forking Environment Variables

📘

Using Environment Variables in Postman

To learn more about the benefits of storing variables in Postman, see Using Variables in Postman.

1. Fork Environment Variables: You can create your own environment variables, but the "Development" environment is set up to work well with the provided collections.

2. Configure the Environment: Before making API calls, configure the environment. Ensure "Development" is selected as the environment to ensure the collection knows where to grab variables from. Without this, API calls will not work.