Beginner – Foundation · Module A
Reading API Documentation Like a Pro
Where to look first, and how to test an endpoint before you've written a line of integration code.
What this session covers
- Start with the authentication section, not the endpoints — nothing else works until you can actually make an authorized call.
- Find the 'quickstart' or example request before the full reference — a working example teaches you more than a parameter table.
- Test every endpoint in a tool like Postman or curl before writing integration code — isolate 'does the API work' from 'does my code work.'
- Check the changelog or versioning section — knowing which API version you're reading against prevents hours of confusion later.
Worked example
Integrating with GitHub's API, you skip the 200-endpoint reference and go to 'Authenticating to the REST API' first. You create a token, run the quickstart `curl` for /user, and only then look up the repository endpoint — so when it later returns 404, you already know auth works and the problem is the repo name.
Exercises
- Open the Stripe or GitHub API docs and, in 15 minutes, find: how to authenticate, one working example request, the current API version, and how errors are formatted.
- Make one successful authenticated call to a free public API (GitHub's /users/{name} works without a token) using curl, then repeat it in Postman.