Exploring APIs in the Developer Portal
Use this page as the orientation hub for the portal browsing and testing flow.
What this page covers
- Where to start after sign-in
- Which page to use for each portal task
- What success looks like before moving to implementation
When to use this page
Use this page when you are new to the portal or when onboarding a new consumer team.
Step-by-step path in the portal
- Sign in and pick profile
- Start at Getting Access.
- Complete magic-link sign-in and confirm the selected profile.
- Open dashboard and assigned collections
- Continue to Dashboard and Collections.
- Browse endpoint definitions
- Use Explore Endpoints.
- Run requests in browser
- Use Testing Console.
- Export for integration
- Use cURL and OpenAPI.
OpenAPI export
Every collection in the portal can be exported as an OpenAPI specification — available in two formats:
| Format | Best for |
|---|---|
| OpenAPI 3.0 | Postman, Swagger UI, most code generators |
| OpenAPI 3.1 | Maximum schema expressiveness; use with tools that support the latest spec |
Click Download OpenAPI on the collection detail page and select your preferred version.
What to verify
- You can see only collections assigned to your client/profile.
- Endpoint docs show required path/query/header/body fields.
- Test calls return expected status and payload.
- Exported OpenAPI/cURL output matches the tested endpoint.
Common confusion points
- No collections visible: likely client/profile assignment issue.
- Try it request fails with
401/403: check active profile and auth headers. - Wildcard routes look broad: use Wildcard Routing and Testing.