Do you ever think that why every freelancing platform have their own data and it's not integrated each other, so if you wanna find a freelancer to hire you should look into different platforms? So this API might help any new freelancing platform to integrate data each other, and you can customize your own tax or fee for your platform services, or developing a features that value your platform from other platform.
This API intentionally to support integration data of freelancers into such of freelancing platform or marketplace. So any platform could focus building their own features instead, and use this API to integrate data of freelancers.
Example, if you building a platform XYZ and you need data about freelancers, you could use this API to integrate with freelancers data, and you can focus to build a features for your platform such as chatbot, real-time chat for freelancer, customer service chat, built-in meeting feature, and etc.
- api-key: YOUR_API_KEY
| Key | Type | Value |
|---|---|---|
| size | number | MAX_DATA_IN_PAGE |
| page | number | CURRENT_PAGE |
| sortBy | string | user: ["username","email"] transaction: ["amount", "status"]" |
| sortOrder | string | ["asc", "desc"] |
- Get all user as a public
/v1/users/public- Register new user
/v1/auth/registerBody
| Value | Type | Optional |
|---|---|---|
| first_name | string | ✖️ |
| last_name | string | ✖️ |
| username | string | ✖️ |
| string | ✖️ | |
| password | string | ✖️ |
| phone | [countryID] + number | ✔️ |
| street | string | ✔️ |
| city | string | ✔️ |
| province | string | ✔️ |
| country | string | ✔️ |
| description | string | ✔️ |
- Login a user
/v1/auth/loginBody
| Value | Type |
|---|---|
| string | |
| password | string |
- Get information of all user
/v1/users- Get current logged in user
/v1/user/:username- Get a user information
/v1/user/find?username="USERNAME"| Query | Type |
|---|---|
| username | string |
- Logout current user
/v1/auth/logout- Get all transaction log
/v1/transactions- Get transaction log by id or payment id (ONLY ADMIN)
/v1/transaction/:_id- Create new transaction log
/v1/transaction/newBody
| Value | Type |
|---|---|
| payment_id | string |
| sender_email | string |
| receiver_email | string |
| amount | number |
| message | string |
| status | string enum [ UNPROCESSED, FAILED, PENDING, DONE ] |
- Update user data
/v1/user/:usernameBody
| Value | Type | Optional |
|---|---|---|
| new_first_name | string | ✔️ |
| new_last_name | string | ✔️ |
| new_username | string | ✔️ |
| new_phone | number | ✔️ |
| new_street | string | ✔️ |
| new_city | string | ✔️ |
| new_province | string | ✔️ |
| new_country | string | ✔️ |
| new_description | string | ✔️ |
all value here is optional, just fill what you need and leave the rest empty or remain as current value
- Update transaction status by id or payment id (ONLY ADMIN)
/v1/transaction/:_id| Value | Type | Optional |
|---|---|---|
| new_payment_id | string | ✔️ |
| new_sender_id | string | ✔️ |
| new_receiver_id | string | ✔️ |
| new_amount | number/integer | ✔️ |
| new_message | string | ✔️ |
| new_status | string | ✔️ |
new status must be one of: [ UNPROCESSED, FAILED, PENDING, DONE ]
- Delete user by username
/v1/user/:username- Delete transaction by id or payment id (ONLY ADMIN)
/v1/transaction/:_id