This infographic summarizes the vocabulary used in HTTP API integrations: requests, endpoints, responses and access controls. It is a visual reference for following a conversation or revisiting a term. The practical API guide develops these concepts through an order-history feature and the questions needed to evaluate its integration.
Read the exchange from the requesting application
An application sends a request to an endpoint, including the HTTP method and the information needed for the operation. The receiving service applies its rules and returns a response. A status code describes the HTTP outcome, while the body may contain records, an operation’s state or error details. In a payment flow, a successful request can still leave later business processing pending.
The method is a useful clue to the operation. GET retrieves a representation, POST submits data for processing, PUT creates or replaces resource state, PATCH applies a partial change and DELETE requests removal of a resource. Data retention and permanent deletion depend on the API contract. JSON is a common format for the fields and values exchanged, not a requirement for every API.
Use the diagram to locate the next question
- For identity, permissions and disconnection, read API keys vs. OAuth. OAuth is an authorization framework, not simply another name for signing in.
- For the volume of calls an integration can make, see API rate limits. Pagination can require several calls to retrieve a complete result set.
- For later state changes, compare webhooks and polling. Notifications and API queries can work together.
- For adoption and investment decisions when the API itself is the offering, continue with API product management.
The book APIs for Product Managers develops the concepts behind the infographic. For a first integration review, the guide’s integration brief connects them to concrete requirements.
