WEBVTT

00:00:00.000 --> 00:00:06.000
What does a developer mean by an API endpoint?

00:00:06.000 --> 00:00:13.000
For a web API, the address and HTTP method identify the intended request operation.

00:00:13.000 --> 00:00:18.000
Read the method, path and expected response together.
6 API-endpoint basics.

00:00:18.000 --> 00:00:30.000
Start with the API address
The provider identifies the service address used for requests.
Service address · Correct environment · Provider documentation

00:00:30.000 --> 00:00:42.000
Read the resource path
The path identifies the resource or operation being addressed.
Resource path · Relevant identifier · Expected destination

00:00:42.000 --> 00:00:54.000
Check the HTTP method
Different methods can request different actions at the same path.
Request method · Intended action · Supported operation

00:00:54.000 --> 00:01:06.000
Supply the required values
An endpoint may need path values, query parameters or a request body.
Path value · Query parameter · Request content

00:01:06.000 --> 00:01:18.000
Use the required access
Follow the provider instructions for authentication and permission.
Authentication method · Permitted operation · Appropriate access

00:01:18.000 --> 00:01:30.000
Inspect the response
Check the status and returned information against the documented result.
Response status · Returned information · Expected structure

00:01:30.000 --> 00:01:39.000
Your checklist
Start with the API address · Read the resource path · Check the HTTP method · Supply the required values · Use the required access · Inspect the response

00:01:39.000 --> 00:01:47.000
Use the provider documentation for the exact endpoint and permitted operation.
jerseyweb.je