Intermediate REST API Documentation exercises

Solution to Exercise 1

1. Overview

The **Payment Gateway API** allows merchants to process secure online transactions using various payment methods such as credit cards and digital wallets.

2. Authentication

The API uses OAuth 2.0 authentication. To make a request, obtain an access token and include it in the `Authorization` header.

3. Endpoints and Methods

POST /transactions – Initiates a new payment transaction.

4. Request Parameters

5. Sample cURL Request

        curl -X POST "https://api.paymentgateway.com/transactions" 
        -H "Authorization: Bearer {access_token}" 
        -H "Content-Type: application/json" 
        -d '{
            "amount": 100.50,
            "currency": "USD",
            "payment_method": "credit_card",
            "merchant_id": "abc123"
        }'
        

6. Error Handling

Common errors include:

Solution to Exercise 2

1. Overview

The **Ride-Sharing API** enables users to book rides, track their status, and cancel rides if necessary. It provides real-time updates on driver availability, estimated fare, and ride status.

2. Authentication

The API uses OAuth 2.0 authentication. Clients must request an access token and include it in the `Authorization` header.

3. Endpoints and Methods

• POST /book – Books a new ride.
• GET /status/{ride_id} – Retrieves the ride's current status.
• DELETE /cancel/{ride_id} – Cancels an ongoing ride.

4. Request Parameters (Booking)

5. Sample cURL Request (Booking a Ride)

        curl -X POST "https://api.ridesharing.com/book" 
        -H "Authorization: Bearer {access_token}" 
        -H "Content-Type: application/json" 
        -d '{
            "pickup_location": "123 Main St, New York",
            "dropoff_location": "456 Park Ave, New York",
            "vehicle_type": "Sedan",
            "payment_method": "credit_card"
        }'
        

6. Error Handling

Common errors include:

Solution to Exercise 3

1. Overview

The **Social Media API** allows users to create posts, retrieve their feed, and interact with other users' content through likes.

2. Authentication

The API requires OAuth 2.0 authentication. Clients must request an access token and include it in the `Authorization` header.

3. Endpoints and Methods

• POST /posts – Creates a new post.
• GET /feed – Retrieves the latest posts from followed users.
• POST /posts/{post_id}/like – Likes a post.

4. Request Parameters (Creating a Post)

5. Sample cURL Request (Creating a Post)

        curl -X POST "https://api.socialmedia.com/posts" 
        -H "Authorization: Bearer {access_token}" 
        -H "Content-Type: application/json" 
        -d '{
            "user_id": "user_12345",
            "content": "Exploring the new Social Media API!",
            "media_url": "https://example.com/image.jpg"
        }'
        

6. Error Handling

Common errors include:

Solution to Exercise 4

1. Overview

The **E-Commerce API** allows customers to browse products, place orders, and track order status in real-time.

2. Authentication

The API requires an API key for authentication. Customers and Admins have different access levels.

3. Endpoints and Methods

• GET /products – Retrieves a list of products.
• POST /orders – Places a new order.
• GET /orders/{order_id} – Retrieves order status.

4. Request Parameters (Placing an Order)

5. Sample cURL Request (Placing an Order)

        curl -X POST "https://api.ecommerce.com/orders" 
        -H "Authorization: Bearer {api_key}" 
        -H "Content-Type: application/json" 
        -d '{
            "customer_id": "cust_12345",
            "items": [
                {
                    "product_id": "prod_98765",
                    "quantity": 2
                }
            ],
            "payment_method": "credit_card",
            "shipping_address": "789 Commerce St, New York"
        }'
        

6. Error Handling

Common errors include:

Solution to Exercise 5

1. Overview

The **Weather Forecast API** provides real-time weather updates, hourly and daily forecasts, and severe weather alerts for various locations worldwide.

2. Authentication

The API requires an API key for authentication. Each request must include the `apikey` parameter.

3. Endpoints and Methods

• GET /current – Retrieves current weather for a location.
• GET /forecast – Retrieves a 7-day weather forecast.
• GET /alerts – Retrieves active severe weather alerts.

4. Request Parameters (Current Weather)

5. Sample cURL Request (Getting Current Weather)

        curl -X GET "https://api.weatherforecast.com/current?location=New+York&apikey=your_api_key" -H "Accept: application/json"
        

6. Error Handling

Common errors include: