Welcome to the Ivern Studios API documentation! This API provides functionality to manage the studio company information with user authentication, built with Flask and MySQL.

• REST API stands for "Representational State Transfer Application Programming Interface".

• It is an architectural style for an API that uses HTTP requests to access and use data, and exchange it securely over the internet. REST API is an a way for two computer systems to communicate.

• For instance, when a developer requests YouTube API to fetch a user's object or a resource, the API will send back the state of that user, their name, subscribers, and videos or posts shared on YouTube. This is possible due to the API integration projects. This also applies to some other websites such as Twitter and Facebook.

• It interacts with resources by using representations such as in JSON, XML, or HTML format.

• REST API uses resources that are represented by URIs, and each of them can be identified by a unique URL.

• REST APIs also have a uniform interface that simplifies the architecture, typically achieved by sticking to standard HTTP methods or the CRUD:

GET: Retrieve information from the server.

POST: Send data to the server to create or update a resource.

PUT: Update a resource on the server.

DELETE: Remove a resource from the server

• In simple terms, this REST API is a set of rules or conventions for building/interacting with web services. It also relies on a stateless, client-server communication protocol like HTTP or the Hypertext Transfer Protocol.

1. Create or Clone the Repository:

   git clone https://github.com/pavseh/CRUD-REST-API_Buala

2. Navigate to the project directory:

   cd BUALA-FINALS-NEW

3. Install all the required dependencies or libraries:

   pip install -r requirements.txt

   or can install them one by one:

   pip install Flask Flask-MySQLdb Flask-RESTful Flask-JWT-Extended

   pip install hmac

   This HMAC or Hash-based Message Authentication Code may be already inside the rest of the installed libraries. This module ensures that the data is safe to any attacks and safeguard its integerity. It can be only accessed and unlocked with the right secret key.

4. Set up the MySQL database by executing the SQL Database I made for the program: ivernstudios.sql.

5. Make sure that all the configurations of the SQL Database is already set up.

app.config["MYSQL_HOST"] = "localhost"
app.config["MYSQL_USER"] = "root"
app.config["MYSQL_PASSWORD"] = "password"  # I used 111004
app.config["MYSQL_DB"] = "name" # I used ivernstudios
app.config["MYSQL_CURSORCLASS"] = "DictCursor"

6. Setting up your MySQL database:

   • Open a MySQL database named ivernstudios.
   • Update the database connection settings in api_buala.py with your MySQL username, password, host, and name of the database.

7. Lastly, run the Flask App: (do not run the tester.py)

   python api_buala.py

8. The application should now be running locally. Access it in your browser or Postman at http://localhost:5000.

1. Run the Flask App:

   python or py api_buala.py

2. The API will be accessible at http://localhost:5000.

Once you have the app running, you can now do the following actions:

• Add an employee
• View all employees
• Update/Remove existing employee/s
• Can view the employee in JSON/XML format (I used JSON for this one.)

I used Postman for the CRUD or Create (Post), Read (Get), Update (Put), Delete (DELETE).

• POST /add_employee: Create a new employee.
• GET /employees: View all employees.
• PUT /update_employee: Update an existing employee.
• DELETE /delete_employee: Delete an employee.

To authenticate, send a POST request to /auth with JSON containing username and password:

With Postman, you can go to the Auth Type > Bearer Token, then paste the token for authorization (This applies to PUT/UPDATE and DELETE) of the program.

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmcmVzaCI6ZmFsc2UsImlhdCI6MTcxNjUzNDA4NCwianRpIjoiZmMwZmNkZmUtY2U2OC00N2U4LWEwMzgtNWQ1MGU3MzM2ZTMyIiwidHlwZSI6ImFjY2VzcyIsInN1YiI6MSwibmJmIjoxNzE2NTM0MDg0LCJjc3JmIjoiNzVmYThhOWUtNTJlMi00M2YxLWJjYWMtZTJiZGNjZDk4NTRmIiwiZXhwIjoxNzE2NTM0OTg0fQ.oCFPq67v6dnOMLE2vDZgqKQSVldQsQeSp6OCnb4FIq8

Username: admin
Password: buala