API interaction scripts in Bash Scripting - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is an API in the context of scripting?

An API (Application Programming Interface) is a way for programs to talk to each other. In scripting, it lets your script send requests to a service and get data back.

beginner

Which command is commonly used in bash scripts to interact with APIs?

The curl command is commonly used to send HTTP requests to APIs from bash scripts.

intermediate

How do you include headers like API keys in a curl request?

Use the -H option with curl. For example: curl -H "Authorization: Bearer YOUR_API_KEY" URL

beginner

What does the -X POST option do in a curl command?

It tells curl to send a POST request instead of the default GET request. POST is used to send data to the API.

intermediate

Why is it useful to parse API responses in bash scripts?

Parsing API responses lets your script understand the data returned, so it can make decisions or show useful info. Tools like jq help extract data from JSON responses.

Which command sends a GET request to an API in bash?

A curl https://api.example.com/data

B curl -X POST https://api.example.com/data

C curl -d '{"key":"value"}' https://api.example.com/data

D curl -H 'Content-Type: application/json' https://api.example.com/data

By default, curl sends a GET request. Option A is a simple GET request.

How do you add a header for an API key in a curl request?

A curl -H 'Authorization: Bearer YOUR_API_KEY' URL

B curl -X GET YOUR_API_KEY URL

C curl --api-key YOUR_API_KEY URL

D curl -d 'Authorization=YOUR_API_KEY' URL

Headers are added with -H option. Authorization header is common for API keys.

What tool helps parse JSON responses in bash scripts?

A sed

B grep

C awk

D jq

jq is designed to parse and filter JSON data easily.

Which HTTP method is used to send data to an API?

A GET

B DELETE

C POST

D HEAD

POST is used to send data to an API, often to create or update resources.

What does the -d option do in a curl command?

A Deletes data from the server

B Adds data to send in the request body

C Displays detailed output

D Downloads a file

-d sends data in the request body, usually with POST requests.

Explain how you would write a bash script to get data from an API that requires an API key.

Think about how to include the API key in the request headers.

Describe how to handle and extract useful information from a JSON API response in a bash script.

Consider tools that help read JSON in bash.