Overview
Postman can be used to quickly test SpringAPI endpoints before integrating them into your application.
This is the fastest way to validate:
Base URL selection
Authentication header configuration
Endpoint behavior
Using Postman is not required. This is simply a how-to for those interested in doing so.
Step 1: Create a New Request
Open Postman
Click New → HTTP Request
Select the GET method
Enter a full SpringAPI URL
Example:
https://api.awardspring.com/api/award-cycles
Step 2: Add Authentication Header
Navigate to the Headers tab and add:
Key | Value |
X-Spring-API-Key | YOUR_API_TOKEN |
Step 3: Send the Request
Click Send.
If configured correctly, you should receive:
200 OK
A JSON response body
If authentication fails, you will receive:
401 Unauthorized
Step 4: Test Other Endpoints
Replace the URL path with any documented endpoint.
Example:
https://api.awardspring.com/api/scholarship/get-available-dollars/12345
Ensure:
You are using the correct regional base URL
Path parameters are valid
The API token has appropriate access and
The API token has not been revoked or is not expired
Optional: Save to a Collection
You may save requests to a Postman Collection for reuse by your IT or development team.
Notes
All requests must use HTTPS
Tokens must be included in every request
All responses are returned in JSON format