Postman Collection¶
Everything you need to explore the API from Postman: one collection covering all 27 requests, with automatic token handling — no manual "Get New Access Token" step, ever.
Download¶
| File | Purpose |
|---|---|
| FSRI-Partner-API.postman_collection.json | The collection — all endpoints, grouped by feature, with response-shape test scripts |
| FSRI-Partner-API-Sandbox.postman_environment.json | Sandbox variables (URLs pre-filled — add your credentials) |
| FSRI-Partner-API-Production.postman_environment.json | Production variables (for after certification) |
Import (one-time)¶
- Postman → Import → drag all three JSON files in.
- You'll see FSRI Partner API under Collections and both environments in the environment dropdown (top-right).
Add your credentials (one-time, per environment)¶
Open the environment and fill in the three values FSRI issued you:
| Variable | What goes in it |
|---|---|
partnerClientId |
Your Client ID |
partnerClientSecret |
Your Client Secret (stored as a Postman secret) |
apiKey |
Your API key (sent as x-api-key on every request) |
Leave accessToken / tokenExpiresAt empty — the collection manages them automatically.
Never commit or share a populated environment file.
Run requests¶
- Select the environment (top-right dropdown).
- Open any request and Send — that's it. A collection-level pre-request script mints the OAuth2 token on first use, caches it, and refreshes it ~5 minutes before expiry.
Suggested first run: Public → Health check (validates your apiKey), then Courses → List courses (validates the full auth chain), then Users → Register user (stores lastUserUuid for the user-scoped requests).
Request chaining¶
Several requests use variables captured by earlier test scripts — e.g. Register user stores lastUserUuid; list requests store lastModuleId and friends. Run folders top-to-bottom (or use the Collection Runner) if a request complains about an unresolved {{last…}} variable.
Troubleshooting¶
| Symptom | Cause |
|---|---|
403 with empty body |
apiKey missing/wrong in the environment |
401 |
Token mint failed — check the Postman console (usually wrong partnerClientId/partnerClientSecret) |
| Console: "Set partnerClientId…" | Environment not selected, or credentials not filled in |
404 on user-scoped requests |
lastUserUuid not set — run Register user first |
Full error reference: Error Handling.