API Documentation

Overview

Overview of Auction System with API Services! Larva Tech Incorporation is proud to present its comprehensive Auction System, equipped with API services, to revolutionize the online auction industry. Our platform provides a seamless and efficient experience for buying and selling a wide! range of goods and services through an intuitive bidding process. With the integration of API services we ensure smooth communication and data exchange between different components, enhancing functionality and integration capabilities.

Features

Allow users to register for an auction system account
Allow users to generate or add an item for bidding
Allow users to filter and search an item
Allow users to see the higher bids and the number of bidders of am specific item.
Allow user to add bid amount
Allow use to update bid amount
Allow user to see the amount and time that the auction item is purchased.
Allow item owner to see who are the buyer or buyer ID

Architectural Design

This is the Architectural Design Model: :
https://trello.com/1/cards/648d91199b8053857ec41d33/attachments/648d9163ea8866f1d7f121b2/download/achi_des.jpg

get keywords

KEYWORD PARAMETERS

Field	Type	Description
q	String	query for show name feature
s	String	A search word to find character by name.
token	String	for authorization of users to access microservices in gateway

Authorization

PERFORMING BASIC AUTHORIZATION

A password and an email are required for basic authorization before it will To access all the microservices, provide an access token. In order to register, It requires a name, email address, password, and also provides an access token.

Login

       
            
             {
          
                 "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.
eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDQvYXBpL3JlZ2lzdGVyIiwiaWF0IjoxNjg3MTU4Mj
U3LCJleHAiOjE2ODcxNjE4NTcsIm5iZiI6MTY4Nz 
E1ODI1NywianRpIjoiZGd4YkpHS3c2VHFxaEhzMSIsInN1YiI6IjciLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZT
cwMWM0MDA4NzJkYjdhNTk3NmY3In0.qPuKIOGd8aHWZLYW2
UrEXAdc6BCGqltTAXtbdrs7cGI",
             
              
               "token_type": "bearer",
               "user": {
                   "id": 7,
                   "name": "Sean Kirk Handayan",
                   "email": "seanhandayanawdawd@gmail.com",
                   "password": "$2y$10$qO5MQk8/hs6McO3VkWz/DO0QtI.oZyLz6p/WeylSLBgh.bYVH1KhK",
                   "created_at": "2023-06-19T07:04:17.000000Z",
                   "updated_at": "2023-06-19T07:04:17.000000Z"
               },
               "expires_in": 86400
           }

Registration

       
            
             {
          
                 "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.
eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwMDQvYXBpL3JlZ2lzdGVyIiwiaWF0IjoxNjg3MTU4Mj
U3LCJleHAiOjE2ODcxNjE4NTcsIm5iZiI6MTY4Nz 
E1ODI1NywianRpIjoiZGd4YkpHS3c2VHFxaEhzMSIsInN1YiI6IjciLCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZT
cwMWM0MDA4NzJkYjdhNTk3NmY3In0.qPuKIOGd8aHWZLYW2
UrEXAdc6BCGqltTAXtbdrs7cGI",
             
              
               "token_type": "bearer",
               "user": {
                   "id": 7,
                   "name": "Sean Kirk Handayan",
                   "email": "seanhandayanawdawd@gmail.com",
                   "password": "$2y$10$qO5MQk8/hs6McO3VkWz/DO0QtI.oZyLz6p/WeylSLBgh.bYVH1KhK",
                   "created_at": "2023-06-19T07:04:17.000000Z",
                   "updated_at": "2023-06-19T07:04:17.000000Z"
               },
               "expires_in": 86400
           }

Features

User

SHOW SPECIFIC NAME

The q keyword and the value supplied determine which name will be displayed by this feature route. It will be beneficial to the client and admin sides so they may perform a user name search.

GET

localhost:8004/name/search

Request

Params

Key: q

Value: jayc

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
data: [ { "id": 3,
"name": "Jayce Tabobo",
"email": "jaycetabobo@gmail.com",
"password":"$2y$10$UWdbG6xVHWAd74kre0r4Kue/qcB08kj2JhM75tnthtD6S6bse6Zs6",
"created_at": "2023-06-19 01:46:15",
"updated_at": "2023-06-19 01:46:15"
} ] }

Inventory

Search Item Name

The "Search Item Name" feature allows both clients and administrators to easily search for specific item names within a system or application. By using the "s" keyword and providing a value, users can initiate a search query to find the desired item name. This feature enhances user experience by enabling efficient and convenient searching capabilities, benefiting both clients and administrators.

GET

localhost:8004/filter

Request

Params

Key: s

Value: luna

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

[ { "ItemID": 1,
"ItemName": "Lunar Meteorite Fragment",
"Description": "This extraordinary lunar meteorite fragment is an authentic piece from the Moon, offering a glimpse into our celestial neighbor. It was formed billions of years ago during a meteorite impact on the lunar surface. The fragment exhibits fascinating lunar regolith texture and is accompanied by a certificate of authenticity. It's a remarkable keepsake for space enthusiasts and collectors alike.",
"StartingBid": "2500.00",
"CurrentBid": "9050.00",
"BidderID": 2
} ]

Show Higher Bids Item

The Show Higher Bids Item function displays the item name as well as the current bid. bids, and the overall order of bids is displayed from highest to lowest.

GET

localhost:8004/highbids

Request

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
"data": [
{
"ItemName": "Lunar Meteorite Fragment",
"CurrentBid": "9050.00"
},
{
"ItemName": "MacBook Pro",
"CurrentBid": "1500.00"
}
],
"database": "inventory"
}

Update Bid Amount

This feature involves updating the bid amount in a bidding system. The feature is designed to trigger an update under certain conditions. Specifically, if the user's bid exceeds both the starting bid and the current bid, and the bid is associated with a specific item ID, the bid amount will be updated.

This suggests that the feature allows users to participate in a bidding process where they can place bids on items. When a user submits a bid for a particular item, the system compares the user's bid amount with the starting bid and the current highest bid. If the user's bid is higher than both of these amounts and is linked to the correct item ID, the bid amount will be adjusted or updated.

PUT

localhost:8004/updatebid/45

Request

Params

Key: BidAmount

Value: 9400

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
"table 1": {
"ItemID": 1,
"ItemName": "Lunar Meteorite Fragment",
"Description": "This extraordinary lunar meteorite fragment is an authentic piece from the Moon, offering a glimpse into our celestial neighbor. It was formed billions of years ago during a meteorite impact on the lunar surface. The fragment exhibits fascinating lunar regolith texture and is accompanied by a certificate of authenticity. It's a remarkable keepsake for space enthusiasts and collectors alike.",
"StartingBid": "2500.00",
"CurrentBid": "9051",
"BidderID": 2
},
"table 2": {
"BidID": 45,
"ItemID": 1,
"BidderID": 2,
"BidAmount": "9051",
"BidTime": "2023-06-18"
},
"database": "inventory"
}

Add Bid Amount

This feature involves adding a bid amount to a specific item. This feature allows users to contribute or increase the current bid amount associated with a particular item in the bidding system.When utilizing this feature, users have the ability to input a bid amount that they wish to add to a specific item. This bid amount can be higher or lower than the current bid, depending on the bidding strategy or preferences of the user.

POST

localhost:8004/add/bidamount

Request

Params

Key: ItemID Value: 12
Key: BidderID Value: 3
Key: BidAmount Value: 1500

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
"data": {
"ItemID": "12",
"BidderID": "3",
"BidAmount": "1500",
"BidTime": "2023-06-19T09:17:59.773163Z",
"BidID": 47
},
"database": "inventory"
}

Show Bid Details

The feature is designed to provide detailed information about a specific bid by utilizing a BidID. With this feature, users can retrieve comprehensive details and insights regarding a particular bid within the bidding system.

GET

localhost:8004/bid/info/45

Request

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
"BidderID": 2,
"BidAmount": "9051.00",
"ItemName": "Lunar Meteorite Fragment"
}

Transaction

Claim Item

The feature mentioned allows users to claim the items they have won using the unique ItemID associated with each item. When users participate in a contest, auction, or any other activity where they have the chance to win items, they are assigned an ItemID when they successfully win an item.

GET

localhost:8004/t/claim/1

Request

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
"data": {
"ItemID": 1,
"BuyerID": 1,
"TransactionAmount": "2500.88",
"TransactionTime": "2023-06-08 18:31:29"
},
"database": "Transaction"
}

Show Buyer Details

The feature allows sellers to view the buyer or winner of an item they have sold using the ItemID associated with that particular item. When sellers list items for sale on the auction system each item is typically assigned a unique ItemID.

With this feature, sellers can easily access information about the buyer or winner of an item by entering the ItemID into a designated section or page on the platform.

GET

localhost:8004/buyer/1

Request

Authorization

Bearer Token

Token:

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOi8vbG9jYWxob 3N0OjgwMDQvYXBpL2xvZ2luIiwiaWF0IjoxNjg 3MTYxMTY4LCJleHAiOjE2ODcxNjQ3NjgsIm5iZiI6MTY4NzE2MTE2OCwianRpIjo iWEVxeHYxZkRXcHNtSmJGYyIsInN1YiI6IjEiLCJwcnYiOiIyM2JkNWM4OTQ5Z jYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3In0.7ff3odgrSRmva1vhXf7NxUWl-fHLQMhV2AnURaaUQ0Q

Response: 200

{
"data": [
{
"ItemID": 1,
"BuyerID": 1
}
],
"database": "Transaction"
}