API Endpoints Explained: Where a Software Request Is Sent

The six points in the video

This is a silent video. The headings, explanations and labels below reproduce the information on screen.

1. 1

   Step 1: Start with the API address

   0:18

   The provider identifies the service address used for requests.

   On-screen labels: Service address; Correct environment; Provider documentation.

2. 2

   Step 2: Read the resource path

   0:30

   The path identifies the resource or operation being addressed.

   On-screen labels: Resource path; Relevant identifier; Expected destination.

3. 3

   Step 3: Check the HTTP method

   0:42

   Different methods can request different actions at the same path.

   On-screen labels: Request method; Intended action; Supported operation.

4. 4

   Step 4: Supply the required values

   0:54

   An endpoint may need path values, query parameters or a request body.

   On-screen labels: Path value; Query parameter; Request content.

5. 5

   Step 5: Use the required access

   1:06

   Follow the provider instructions for authentication and permission.

   On-screen labels: Authentication method; Permitted operation; Appropriate access.

6. 6

   Step 6: Inspect the response

   1:18

   Check the status and returned information against the documented result.

   On-screen labels: Response status; Returned information; Expected structure.

See it in a diagram

Read the diagram as text

1. Request: Method and required values
2. Endpoint: The documented destination
3. Response: Status and returned information

Check the intended operation. Use the correct environment and appropriate authentication before sending requests.

Keep credentials and private request information out of shared examples.

Diagram by Jersey Web. Open full size · Source and further detail (opens in a new tab)

Common questions

Go further