F3 Services API Reference (1.0.0)

Download OpenAPI specification:Download

This document provides a comprehensive reference guide for the F3 Services API. The F3 Services API is a set of RESTful endpoints that allow developers to programmatically interact with F3 Services. This document includes detailed descriptions of each available endpoint, as well as the parameters, methods, and data structures used by the API.

Copyright: © Keture 2023. All rights reserved. This API reference is provided solely for the purpose of development and testing. Any commercial use or redistribution of this API, or any part thereof, is strictly prohibited without the prior written consent of Keture.

Auth service

The authentication microservice is responsible for managing user accounts, providing a secure login mechanism, and enforcing access control to the system.

/api/auth/v1/{lang}/register

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

name required	string
mobile_number required	string
password required	string
role required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "Josiah",
"mobile_number": "766641295",
"password": "123456",
"role": "FISHER"
}

Response samples

200
500

Content type

application/json

{"message": "Your account has been created successfully."
}

/api/auth/v1/{lang}/login

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

mobile_number required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"mobile_number": "766641295",
"password": "123456"
}

Response samples

200
500

Content type

application/json

{"id": 5,
"name": "Josiah",
"mobile_number": "766641295",
"role": "FISHER",
"capability_list": ["AUCTIONS/CREATE",
"AUCTIONS/READ",
"USERS/READ"
],
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6NSwicm9sZSI6IkZJU0hFUiIsImNhcGFiaWxpdHlfbGlzdCI6IltcIkFVQ1RJT05TL0NSRUFURVwiLFwiQVVDVElPTlMvUkVBRFwiLFwiVVNFUlMvUkVBRFwiXSIsImlhdCI6MTY3NzA5MDAyOCwiZXhwIjoxNjc5NjgyMDI4fQ.eVaKBdWFXYNEfyoJtZd56Fubuj0In2w-1GHcjYA1BoE"
}

/api/auth/v1/{lang}/profile

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401
500

Content type

application/json

{"id": 5,
"name": "Josiah",
"mobile_number": "766641295",
"role": "FISHER"
}

/api/auth/v1/{lang}/user/activate Deprecated

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

mobile_number

required

string

Responses

Request samples

Payload

Content type

application/json

{"mobile_number": "0771212123"
}

/api/auth/v1/{lang}/user/lock Deprecated

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

mobile_number

required

string

Responses

Request samples

Payload

Content type

application/json

{"mobile_number": "0771212123"
}

Bidding service

The bidding microservice is responsible for managing the entire bidding process for auctions, including starting new auctions, managing bids from users, and enforcing auction rules and regulations.

/api/bidding/v1/{lang}/fish/all

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401

Content type

application/json

[{"id": 1,
"grade": "XL",
"name": "Blue Swimming Crab"
},
{"id": 2,
"grade": "L",
"name": "Blue Swimming Crab"
},
{"id": 3,
"grade": "S",
"name": "Blue Swimming Crab"
},
{"id": 4,
"grade": "VS",
"name": "Blue Swimming Crab"
}
]

/api/bidding/v1/{lang}/fish/new Deprecated

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

names required	string
grade required	string
min_size required	integer
image_url required	string

Responses

Request samples

Payload

Content type

application/json

{"names": "{\"en\":\"Blue Swimming Crab\",\"ta\":\"நீல நீச்சல் நண்டு\",\"si\":\"නිල් පිහිනුම් කකුළුවා\"}",
"grade": "XL",
"min_size": 700,
"image_url": "image path"
}

/api/bidding/v1/{lang}/fish/update Deprecated

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

id required	integer
names	string
grade	string
min_size	integer
image_url	string

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"names": "{\"en\":\"Blue Swimming Crab\",\"ta\":\"நீல நீச்சல் நண்டு\",\"si\":\"නිල් පිහිනුම් කකුළුවා\"}",
"grade": "XL",
"min_size": 700,
"image_url": "image path"
}

/api/bidding/v1/{lang}/fish/delete Deprecated

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"id": 1
}

/api/bidding/v1/{lang}/request/

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401
500

Content type

application/json

[{"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "ACTIVE",
"items": {"grade": "XL",
"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 0
}
}
]

/api/bidding/v1/{lang}/request/

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

scheduled_end_at required	string
item_id required	integer
item_weight required	number
starting_bid_price required	number
images	Array of arrays
description	string

Responses

Request samples

Payload

Content type

application/json

{"scheduled_end_at": "2023-02-25T04:41:47.405Z",
"item_id": 1,
"item_weight": 25.5,
"starting_bid_price": 8000,
"description": "Test Description",
"images": [ ]
}

Response samples

200
401
500

Content type

application/json

{"message": "The auction has been uploaded successfully."
}

/api/bidding/v1/{lang}/request/count

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401
500

Content type

application/json

{"name": "Josiah",
"count": 1
}

/api/bidding/v1/{lang}/request/{id}

Authorizations:

bearerAuth

path Parameters

lang required	string Default: "en"
id required	integer

Responses

Response samples

200
401
500

Content type

application/json

{"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "ACTIVE",
"auction_images": [ ],
"items": {"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"grade": "XL",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 0
}
}

/api/bidding/v1/{lang}/request/cancel

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

auction_id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"auction_id": 1
}

Response samples

200
401
500

Content type

application/json

{"message": "The auction has been successfully cancelled."
}

/api/bidding/v1/{lang}/market/

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401

Content type

application/json

[{"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "ACTIVE",
"auction_images": [ ],
"bids": [ ],
"users": {"name": "Josiah"
},
"items": {"grade": "XL",
"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 0
}
}
]

/api/bidding/v1/{lang}/market/{id}

Authorizations:

bearerAuth

path Parameters

lang required	string Default: "en"
id required	integer

Responses

Response samples

200
401
500

Content type

application/json

{"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "CANCELED",
"users": {"name": "Josiah"
},
"items": {"grade": "XL",
"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 0
}
}

/api/bidding/v1/{lang}/submission/all

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401

Content type

application/json

[{"id": 1,
"bid_price": 10000,
"auctions": {"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "ACTIVE",
"auction_images": [ ],
"bids": [{"bid_price": 10000,
"user_id": 6
}
],
"users": {"name": "Josiah",
"mobile_number": "766641295"
},
"items": {"grade": "XL",
"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 1
}
}
}
]

/api/bidding/v1/{lang}/submission/

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401

Content type

application/json

[{"id": 1,
"bid_price": 10000,
"auctions": {"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "ACTIVE",
"auction_images": [ ],
"bids": [{"bid_price": 10000,
"user_id": 6
}
],
"users": {"name": "Josiah",
"mobile_number": "766641295"
},
"items": {"grade": "XL",
"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 1
}
}
}
]

/api/bidding/v1/{lang}/submission/

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

auction_id required	integer
bid_price required	number

Responses

Request samples

Payload

Content type

application/json

{"auction_id": 1,
"bid_price": 8000
}

Response samples

200
401
500

Content type

application/json

{"message": "The bid has been added successfully."
}

/api/bidding/v1/{lang}/submission/{id}

Authorizations:

bearerAuth

path Parameters

lang required	string Default: "en"
id required	integer

Responses

Response samples

200
401
500

Content type

application/json

{"id": 1,
"bid_price": 10000,
"auctions": {"id": 1,
"scheduled_end_at": "2023-02-25T18:47:49.000Z",
"item_weight": 25.5,
"starting_bid_price": 8000,
"status": "ACTIVE",
"auction_images": [ ],
"bids": [{"bid_price": 10000,
"user_id": 6
}
],
"users": {"name": "Josiah",
"mobile_number": "766641295"
},
"items": {"grade": "XL",
"image_url": "https://ik.imagekit.io/f3fishapp/BlueSwimmingCrab_KQYhehJd2.jpg?ik-sdk-version=javascript-1.4.3&updatedAt=1661015509786",
"name": "Blue Swimming Crab"
},
"_count": {"bids": 1
}
}
}

/api/bidding/v1/{lang}/submission/cancel

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

bid_id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"bid_id": 1
}

Response samples

200
401
500

Content type

application/json

{"message": "The request was successfully completed."
}

Scheduler service

The scheduler microservice is responsible for managing the end of auctions, updating the database with the final results, and notifying users who have placed bids on the auction.

/api/scheduler/v1/{lang}/start

Authorizations:

bearerAuth

path Parameters

lang

required

string

Default: "en"

Request Body schema: application/json

auction_id

required

integer

Responses

Request samples

Payload

Content type

application/json

{"auction_id": 1
}

Response samples

200
401
500

Content type

application/json

{"message": "The request was successfully completed."
}

/api/scheduler/v1/{lang}/startAll

path Parameters

lang

required

string

Default: "en"

Responses

Response samples

200
401
500

Content type

application/json

{"message": "The request was successfully completed."
}