APIs for Topmate

topmate-api-doc.md

APIs

Request Invite

/request-invite/ API to send request for invite for becoming a topmate. Fields required

• Name
• Social URL
• Email
• Phone Number (optional) Method: POST

Login

/login/ Authenticate the user. Input

• Email/Username
• Password

Returns

• Authentication token
• Refresh token

Method: POST

Password update

/update-password/ Input

• Auth token
• New Password

Method: POST

Send password recovery email

/password-recovery-notification/ It sends a password recovery email to the user Input

• Email or Username Method: POST

Self Profile Fetch

/profile/ Returns the profile of the current user Input

• Authentication token

Method: GET

Profile update

/profile/ Input: Either of the following.

• Name
• Profile pic Path
• Title (Max 250 characters) Compulsory)
• Description (MAx 1000 characters)
• Username (Max 100 characters without space)
• Timezone

Method: PATCH

File upload API

Need to figure this out. Whether we want to upload it directly to aws using aws sdk or have it upload it on our server first

Services

/services/ and /service/:id Get list of services

Each service should contain following fields

• id
• title
• description
• duration
• charge

Methods: POST, PATCH, DELETE, GET list and GET Details

Bank details

/bank-details Add/Edit bank details Bank details need to have following details

• Account Name
• Account number
• Account type (Enum with possible value as Savings/Current)
• IFSC code
• Bank
  • Id
  • Name Methods: POST, PATCH, GET

Get list of banks

/banks/ Each bank should contains

• Id
• Name

Withdrawn request

Request to withdraw /request-withdraw/ Method: POST

Availability

Need to check superpeer. They are doing it in a different manner.