MA_Group_Project

API Documentation

Overview

This documentation details the endpoints available in the SuRFM FastAPI application which provides functions to manage and interact with subscriber data for streaming services. The API allows operations such as retrieving, adding, updating, and deleting subscriber information, along with specialized queries for declining and low-value subscribers.

Setup

The API utilizes FastAPI and interacts with an SQLite database via SQLAlchemy. Ensure the following packages are installed:

• fastapi
• sqlalchemy
• pydantic
• sendgrid

API Endpoints

Home Endpoint

• URL: /
• Method: GET
• Description: Displays a welcome message and provides a link to the API documentation.
• Response: A JSON object with a welcome message.

Retrieve Subscriber

• URL: /subscriber
• Method: GET
• Query Parameters:
  • id: Integer, required, the ID of the subscriber to retrieve.
• Description: Fetches a subscriber’s information by their ID.
• Success Response:
  • Code: 200
  • Content: Subscriber data
• Error Response:
  • Code: 404 (Not Found) or 500 (Internal Server Error) with error details.

Add New Subscriber

• URL: /new_subscriber
• Method: POST
• Description: Adds a new subscriber to the database.
• Body:
  • name: String, required
  • email: Email string, required
  • age: Integer, required
  • location: String, required
  • gender: Enum [“Male”, “Female”, “Other”], optional
• Success Response:
  • Code: 200
  • Content: Confirmation message with subscriber ID.
• Error Response:
  • Code: 500 (Internal Server Error) with error details.

Update Subscriber Information

• URL: /update_subscriber
• Method: PUT
• Query Parameters:
  • Subscriber details to be updated.
• Description: Updates existing subscriber details.
• Success Response:
  • Code: 200
• Error Response:
  • Code: 404 (Not Found) or 500 (Internal Server Error) with error details.

Delete Subscriber

• URL: /delete_subscriber
• Method: DELETE
• Query Parameters:
  • subscriber_id: Integer, required, ID of the subscriber to delete.
• Description: Deletes a subscriber from the database.
• Success Response:
  • Code: 200
• Error Response:
  • Code: 404 (Not Found) or 500 (Internal Server Error) with error details.

Declining Subscribers

• URL: /declining_subscribers
• Method: GET
• Query Parameters:
  • from_email: String, optional, email to send from if sending notifications.
  • send_email: Boolean, optional, flag to send emails to declining subscribers.
• Description: Retrieves subscribers who are considered to be declining based on specific criteria and optionally sends them an email.
• Success Response:
  • Code: 200
• Error Response:
  • Code: 500 (Internal Server Error) with error details.

Low Value Subscribers

• URL: /low_value_subscribers
• Method: GET
• Description: Identifies subscribers who fall below a certain threshold of value.
• Success Response:
  • Code: 200
• Error Response:
  • Code: 500 (Internal Server Error) with error details.

Setting Up SendGrid for Email Sending in Python

This guide provides step-by-step instructions on how to set up SendGrid, generate API keys, and integrate SendGrid into your Python application for sending emails.

Step 1: Create an Account on SendGrid

1. Go to the SendGrid website and sign up for an account using your email address and creating a password.

Step 2: Verify Your Account

1. After signing up, verify your account by clicking on the verification link sent to your email address.

Step 3: Access API Keys

1. Once logged in, navigate to the “Settings” section of your SendGrid account. In the left sidebar, under “Settings”, click on “API Keys”.

Step 4: Generate API Key

1. On the API Keys page, click the “Create API Key” button. Give your API key a name and choose the permissions you want to assign to it. For sending emails, you’ll need “Mail Send” permissions.

Step 5: Store API Key

1. After creating the API key, copy the generated API key. Store this key securely in a safe place on your local machine.

Step 6: Set Up Sender Authentication

1. To improve email deliverability and avoid being marked as spam, set up sender authentication. Go to “Settings” > “Sender Authentication” in your SendGrid account and follow the instructions to verify your sender identity.

Step 7: Export API Key as Environment Variable (macOS / Linux)

1. Open your terminal and export the API key as an environment variable using the following command:

export SENDGRID_API_KEY='your_api_key' #Replace 'your_api_key' with the API key you generated earlier.

Step 7: Set Environment Variable (Windows)

1. On Windows, you can set the environment variable using the following command in the command prompt:

set SENDGRID_API_KEY=your_api_key #Replace your_api_key with the API key you generated earlier.

Ensure you replace ‘sender@example.com’ with an appropriate email address.

Congratulations! You have successfully set up and integrated SendGrid for sending emails in Python.

Additional Notes

Ensure Python is installed and all dependencies are met before executing scripts. For any issues or inquiries, reach out to the repository maintainers.

This site is open source. Improve this page.