New: Try Voli The Bear, Fast package manager (and not only) for Windows
All topics / Reading API Docs & Using Postman

Reading API Docs & Using Postman

How to go from an unfamiliar API docs page to a working request: read the reference, fire the call in Postman or curl, and read the response - without guessing.

Download EPUB
  1. How to Read API Docs Every API reference is telling you the same five things: the base URL, the endpoint and method, the parameters, the auth requirement, and an example request and response. Learn where each one lives so you can skim straight to it.
  2. Making the Request (Postman & curl) Postman and curl are two interfaces to the same thing - building an HTTP request out of a method, URL, headers, and body. Build one GET-with-auth request both ways, with an annotated curl transcript.
  3. Reading the Response & Iterating Read the status code before the body, tweak parameters and re-send, and save requests into Postman collections with variables for base URL and token - without ever leaking your API key.