ReverseAuctionMHT
V 0.1
The JWT token that is retrieved from using the /connect method
On some platforms, it is neccesary to override the default content type with “application/json”
The current state of push notifications are automated as long as the following conditions are met:
The user(s) must have the DeviceID portion of their account filled in. This must be supplied be obtained by whichever platform you are on. We currently only support Firebase. As long as those device IDs are filled in. Push Notifications should work accordingly.
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Responses
Body
Request headers
Request body
Responses
Body
API’s for dealing with users. Always found in /api/user/ routes.
This will return you available properties that you can see of a user (Profile)
Request headers
Request body
IDs to search for. At some point this needs to be passports
Examples
Responses
Body
User Desscription
True/False
Request parameters
Request headers
Responses
Body
The connect method allows the client to create and login the user to retrieve their JWT token.
Request headers
Request body
Requires at least; 1 upper case, 1 lowercase, a-Z, 0-9
Whether or not connect should create the user and log them in. If set to false, it will just attempt to log them in
Message to be inserted into the confirm-email.html when a confirmation email gets sent. This string replaces any text inside of the email that is “WELCOMEMESSAGE” (without ")
Responses
Body
JWT token
Currently only functions with email until I properly refactor the outsourced code to work per passport implementation.
Request headers
Request body
Email of the user
Responses
Body
Request headers
Request body
Responses
This is the API for confirmation email, confirm route and resend route.
Needed environment variables are:
SMTPAddress
EmailPort
EmailUser - (smtp login)
EmailPassword (smtp password)
ConfirmEmail (defaults to false, must be set to true)
EmailFrom - Where the email is coming from
ConfirmationExpireTime - defaults to 1,000,000 hours
ConfirmationSecret - defaults to the password secret (NOT ADVISED)
By default, confirmation is turned off unless the ConfirmEmail environment variable is set to true.
Once enabled and smtp details are correct, you will recieve an email which has a link that expires after 1,000,000 hours (this is also settable, look at chaosconfig.js)
There is also an api for resending the confirmation email.
The routes have been included here. The only one thats really supposed to be used however is “Resend Confirmation”. The other route is handled by the automatic emailer.
Also supports get via resendconfirm?Email=email@gmail.com
Request headers
Request body
Responses
Request parameters
Request headers
Responses
Body
Laptop
Macbook Pro, SSD supported with 8GB ram
n90hl
list of tags
3682724y832y48347
Electronics
Request headers
Request body
Responses
Body
Sellers are the owners of products, they are a different user type and sellers set prices on products
work out filers
Contains filters for product category searching and date time and location
Request parameters
Request headers
Responses
Body
Examples
filter?bydate or filer?bycategory or filter?bylocation
Request parameters
Request headers
Responses
Body
Profile types are users and sellers
Request parameters
Request headers
Request body
id of adress current object
Responses
Body
Request parameters
Request headers
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Responses
Body
Request parameters
Electronics
Request headers
Responses
Body
Request headers
Request body
Array of Tag IDs
["5b02949feaee552eae3987b6","5b029494eaee552eae3987b4"]
Id of the model row
Type should be : Store, Product, StoreProduct
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
keyword
page number
Responses
Body
Products aray if searched keyword is also a tag
["5b0655dfb24eba5dbb2c0b14","5b0655c5b24eba5dbb2c0b13","5b0653d3b24eba5dbb2c0b10"]
products array from store, if search keyword is a tag
["5b06521fb24eba5dbb2c0b0e","5b0653d3b24eba5dbb2c0b10","5b0653edb24eba5dbb2c0b12"]
products array which match search algorithm via keyword.
["5b0653d3b24eba5dbb2c0b10","5b0655dfb24eba5dbb2c0b14","5b0655c5b24eba5dbb2c0b13"]
Request headers
Request body
Responses
Body
Body
Request headers
Request body
keyword to be searched
true to fetch result for ocr, false for generic search
true
Responses
Body
Request headers
Request body
Array of tags ID’s
["5b0e87fa30f31d0e90ab1362"]
Type can be Product , StoreProduct, Store
Responses
Success Response For Product
Body
["5b0e87fa30f31d0e90ab1362"]
A seller inputs a bid for the user, the best price on a product
Request headers
Request body
Examples
Responses
Body
to delete a specific bid
Request parameters
Request headers
Responses
Body
Request headers
Request body
Responses
Body
These are the bids that sellers and users make on products.
Request parameters
Request headers
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
“5bfb34b108ed554dbc27e”,“5b0e87ee30f31d0e1361”,“5b0e87fa3090ab1362”,“5b8344b4c4f816a24e29”
“5bfb34b108ed554dbc27e”,“5b0e87ee30f31d0e1361”,“5b0e87fa3090ab1362”,“5b8344b4c4f816a24e29”
to get list of recent top stores
Request headers
Responses
Body
Request headers
Request body
increment on product
Responses
Body
Request headers
Request body
Responses
Body
["5b0e8ad430f31d0e90ab1369"]
If this object is not undefined or null then display this instead produt details
Request headers
Request body
Responses
API related to Auctions
Request parameters
ID of the Auction
The JWT token that is retrieved from using the /connect method
Request headers
Responses
Body
Auctions starts with 10 secs with the status of “Waiting”. When this timer reaches 0. ChangeAuctionStatus API is called with the auction id to set the time for the auction and change the status to “Active”
Request parameters
ID of the Auction to be change
The JWT token that is retrieved from using the /connect method
Request headers
Responses
Body
Api to create Auction of a product
Request headers
Request body
id of profile of user who is actually placing auction.
ID of a product against which user wanted to add product
amount or price for an auction
minutes for auction
if user wants to give any additonal information
Responses
Body
Active, InActive, Completed
Body
To get user specific auctions
Request headers
Request body
Responses
Body
To delete a specific auction
Request parameters
ID of the Auction to be deleted.
Request headers
Responses
Body
strong textTo get all active auctions from the system
Request headers
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
Api methods related to notification services
Request headers
Request body
Responses
Body
Request headers
Request body
Responses
Body
Api related to messages will be here
Request headers
Request body
Responses
Body
Request headers
Request body
productId
base64
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
id of user profile
Responses
Body
Request headers
Request body
AuctionID that has just completed
Responses
Body
Request headers
Request body
Id of the order
True if payment is done. False is payment is later or not done.
Responses
Body
Request parameters
Id of the order to remove from cart
Request headers
Responses
Body
Request headers
Request body
Responses
Body
Request headers
Request body
ProfileID of persons cart
Responses
Body
None error occur
Message from the api
Request parameters
ProfileID of user
Request headers
Responses
Body
Badge object
Shopping cart count
USer live auction count
A user model.
display name of the user
The name of the user
First name
Last name