Understanding APIs: A Beginner's Guide to Tech Terminology
Written on
Chapter 1: What is an API?
If you're in the workforce, you might have encountered terms like APIs, web services, and endpoints in conversations with colleagues. But what do these terms really mean, and how do they differ from one another?
An API, or Application Programming Interface, facilitates communication between different software applications. A web service is a specific kind of API that operates over the internet.
When applications interact, they typically exchange requests and responses.
- Request: A request is when one application asks for something.
- Response: This is the reply to that request.
For instance, consider how App A sends a request to App B, which then sends a response back to App A.
This process is akin to making a request in everyday life—sometimes you receive what you wanted, and at other times, you do not.
For example, when you use Google to search for something, typing your query and hitting enter initiates an API request. Often, Google will respond with a multitude of results, but there are occasions when it may not find anything relevant.
In the next sections, we'll explore some common phrases that tech enthusiasts use when discussing APIs. You'll soon be able to keep up with the jargon!
Requests
- "Make / Fire an API call": This means to initiate a request.
- "Make a GET request": This is a request to retrieve data.
- "Make a POST request": This is a request to create new data.
- "Make a PUT request": This is a request to update existing data.
- "Hit the endpoint": This means to perform a request at a specified URL.
Responses
- "200": Indicates a successful HTTP response.
- "301": Signifies a redirect response.
- "400": Indicates a bad request.
- "401": Denotes unauthorized access.
- "403": Indicates forbidden access.
- "404": Signifies that the requested resource was not found.
- "500": Indicates an internal server error.
- "504": Denotes a timeout response.
Authentication
- "OAUTH": A method that allows applications to grant access via tokens.
- "Token": A form of authentication, akin to a username and password.
- "Refresh the token": Tokens can expire; if you encounter a 401 error, refreshing your API token may help.
General Terms
- "Do they have an API?": This asks if an application can communicate with another app.
- "Open API": An API available for public use.
- "Closed API": An API that is not accessible to the public.
- "API limit": Some APIs restrict the number of requests you can make within a set time period (e.g., 1000 requests per day).
- "CRUD": Represents Create, Read, Update, and Delete operations.
- "Test it with Postman": Postman is a powerful tool for API development.
- "Header": This defines the type of data being transmitted.
- "Body": This contains the actual data being sent.
- "GUID": A Globally Unique Identifier used for unique records (e.g., e20f5d52–5490–4523–87c5-af46dadfe7c1).
- "JSON": A data format characterized by {"key":"value"}.
- "XML": A data format characterized by values.
- "REST(ful) API": An API that follows Representational State Transfer principles.
- "SOAP API": An XML-based API that utilizes Simple Object Access Protocol.
- "GraphQL": A query language designed for APIs.
- "Check their documentation": Most APIs provide a reference page with information on getting started, authentication, and available methods.
Conclusion
The tech community often employs specialized terminology, not to confuse others but to communicate complex ideas efficiently.
For example: "Yes! The API response returned a 200!" or "Try creating a new user. Hit the user endpoint and make a POST request."
With time and exposure, the technical jargon of the industry will become easier to understand.
If you have your own terminology for discussing APIs or any questions about the examples provided, feel free to leave a comment below.
Happy communicating!
Chapter 2: Additional Resources
To further your understanding of APIs, check out the following informative videos:
This video titled "What is an API?" provides a comprehensive overview of APIs, explaining their purpose and functionality in simple terms.
In just one minute, "What is an API Explained in 1 minute #shorts" concisely summarizes what an API is, making it an excellent quick reference.