e17-3yp-maker-mate

3rd year Embedded systems & Software project by @Thilini98, @thanujan96 and @DrMadhushan

Project maintained by cepdnaclk Hosted on GitHub Pages — Theme by mattgraham

Maker Mate API Documentation

Overview

For fundamental knowledge sharing

What is an API?

API stands for Application Programming Interface. An API is a software intermediary that allows two applications to talk to each other. In other words, an API is the messenger that delivers your request to the provider that you’re requesting it from and then delivers the response back to you.

An API defines functionalities that are independent of their respective implementations, which allows those implementations and definitions to vary without compromising each other. Therefore, a good API makes it easier to develop a program by providing the building blocks.

Application programming interfaces consist of two components:

Technical specification describing the data exchange options between solutions with the specification done in the form of a request for processing and data delivery protocols
Software interface written to the specification that represents it

How do APIs work?

API Requests

In our applcation we will be having both authenticated API requests and APIs for public use.

Authenticated API Requests

APIs that will return the data related to the users about their orders.

host/api/auth/user/
host/api/auth/user/orders
host/api/auth/user/orders/{orderId}
host/api/auth/user/orders/{orderId}/otp
host/api/auth/user/orders/{orderId}/otp/{otp}
host/api/auth/user/orders/{orderId}

APIs used in backend that facilitate admins to add, delete or update the information about components and equipments in maker space.

host/api/admin/components/items
host/api/admin/components/items/{componentItem}
host/api/admin/components/types
host/api/admin/components/types/{componentType}
host/api/admin/equipments/items
host/api/admin/equipments/items/{equipmentItem}
host/api/admin/equipments/types
host/api/admin/equipments/types/{equipmentType}

APIs used in order to manage and monitor the orders made by students

host/api/admin/order
host/api/admin/order/{orderId}

Public use API Requests

API requests that need not to be authentcated.

host/api/auth/signup
host/api/auth/login
host/api/auth/logout
host/api/auth/password/email
host/api/auth/password/reset
host/api/components
host/api/components/items
host/api/components/items/search
host/api/components/items/{componentItem}
host/api/components/types
host/api/components/types/search
host/api/components/types/{componentType}
host/api/equipments
host/api/equipments/items
host/api/equipments/items/search
host/api/equipments/items/{componentItem}
host/api/equipments/types
host/api/equipments/types/search
host/api/equipments/types/{componentType}
host/api/search

Some APIs and there details in depth

host/api/auth/login -> email,pass(data)
host/api/auth/user -> token(auth header)
Return the details of the logged in user.
host/api/auth/orders -> token(auth header)
Return the deatils of the orders that have been placed by the user. This will indicate wether the orders are accepted or they are still in progressing stage or weher we can pick them up. This respose will include all the orders that made by the user.
host/api/auth/orders/{orderid} -> token(auth header)
Returns the specific details corresponding to one specific order that has been placed by the user.
host/api/user/orders/id/opt/number -> returns true if it’s same as the otp
This request is used once the user received the op and need to pick up their package.