Automation for clients

Stage 1 · Lesson 5 of 8

REST APIs and reading API documentation

How automation works

A is a common way of organising an API. Each kind of data lives at its own address, called an endpoint, such as /contacts or /invoices/123. You act on it with the you just met: GET a contact, POST a new invoice.

Reading API documentation is a core automation skill. First find the base URL (the start of every address) and how to authenticate (prove who you are). Then find the endpoint you need, its required fields and the shape of the response.

Finally, check (how long lists are split into pages) and . Try each call in Postman, or in your tool's HTTP request step, before building around it. This is how you connect apps a client uses that have no official , and that is often where the paid work is.

Common trapcopying an example from a blog post instead of the official docs, then discovering it uses an old API version.

A question to check yourself, an AI practice session and 2 cheat sheet entries come with the full roadmap. Unlock

Resources for this stage

Start with· follow one of these

  • GuideFree
    MDN: HTTP

    Mozilla · Beginner

    Read the overview, methods, status codes and headers pages: the HTTP every automation tool sits on

  • GuideFree
    JavaScript.info

    Ilya Kantor

    The JSON methods and objects chapters teach you to read and reshape the data each step passes on

Practise

  • Call real APIs by hand, see status codes and headers, before you build anything around them

  • Get a throwaway URL and see exactly what an app sends in a webhook

Keep handy

  • A map of API concepts, from REST and auth to rate limiting, to check what you have not met yet

  • Clear chapters on OAuth flows and scopes for when "Connect your account" stops being magic

Also worth your time

Mark this stage as not done?