BugSmash API Docs
Below API document describes how you can easily use the BugSmash API to generate review link on-the-fly from any of your systems and workflows
Written By Nabil
Last updated 3 months ago
POST / Generate-Review-Link
ExampleAPI --
https://tools.bugsmash.io/backend/api/v2/project/generate-review-link
HEADER --
X-API-Key: YOUR_API_KEY
REQUEST --
--------- For Websites: ---------
Header: Content-Type: application/json
JSON Body
{
"project_name":"Testing project",
"project_type":"website",
"website_url":"https://tailwindcss.com",
"anonymous_comments": true/false // If enabled, guests can leave comments without even logging in
"private_comments": true/false // If enabled, guests would be able to see only their own comments. (This mode needs anonymous_comments to be set to false)
}
--------- For Files (PDF/Image/Video/Audio): ---------
Header: Content-Type: multipart/form-data
Form Data -
{
"project_name":"Testing project",
"project_type":"pdf", // Accepts these values: image/pdf/video/audio
"file": YOUR_FILE_HERE,
"anonymous_comments": true/false // If enabled, guests can leave comments without even logging in
"private_comments": true/false // If enabled, guests would see only their own comments. (This mode needs anonymous_comments to be set to false)
}
--------- For multiple image files in a single project: ---------
Header: Content-Type: multipart/form-data
Form Data -
{
"project_name":"Testing project",
"project_type":"pdf", // Accepts these values: image/pdf/video/audio
"files[]": YOUR_FILE_HERE, //Accepts upto 25 images at once within the array
"anonymous_comments": true/false // If enabled, guests can leave comments without even logging in
"private_comments": true/false // If enabled, guests would see only their own comments. (This mode needs anonymous_comments to be set to false)
}
RESPONSE --
{
"status":true,
"message":"Success",
"project":{
"id":"9fde3ba0-7928-4a3a-8e8b-0cb2e19701ee",
"name": "Testing Project",
"review_link": "https://review.bugsmash.io/YTmK6"
},
}