vetaCloud v0.1 Nest.js Integration - Youtube Tutorial
How to use
npm i axios
controller.ts
@Post('/uploadFile')
@UseInterceptors(FileInterceptor('file'))
async uploadFile(@Req() request: Request, @Res() res: Response, @UploadedFile() file,) {
try{
const response = await this.appService.postFile(file)
return res.status(201).json({
status: 201,
success: true,
message: response
});
}
catch(err){
console.log(err)
return res.status(500).send({
status: 500,
success: false,
message: "Something went wrong",
});
}
}controller.js
import axios from 'axios'Axios is used to post the file to our server. HTTP would be integrated in subsequent versions
Note: Before you can upload your files, you need to create a Route. Route is the directory that you will be uploading your files to. Click here to create one. vetaCloud Cloud service base url is
Your Private Key would be needed for the next process. You can get it here
- Basic upload
- Image upload with optimization in parameters
- Video upload with optimization in parameters
- Delete file
- Fetch all files in a route
- Webhook
- Extra
Your Private key can be found on your dashboard. Make sure you are sending your API KEY and Route Name in the request header. Before pushing to our server, the file is hidden on your server so ensure to keep fs.unlinkSync(req.files.file.path) so as to delete the file from your server.
async postFile(file: File): Promise<{ filePayload: Object; }> {
const uploadResponse = await axios({
maxContentLength: Infinity, maxBodyLength: Infinity,
headers: {
"Content-Type": "application/json",
'X_API_KEY': process.env.VETACLOUD_PRIVATE_KEY, 'X_ROUTE_NAME': process.env.VETACLOUD_INDEX_ROUTE
},
method: 'POST',
url: `${process.env.VETACLOUD_URL}/nest/`,
data: { filename: file.originalname, raw: file.buffer }
})
const filePayload = uploadResponse.data.file
return { filePayload }
}
});Note: The files that are uploaded via this endpoint are subject to the Route type, image optimization specified in the route and the video optimization specified. Leave them as 0 to use the default media file height, width and quality.
Images that are uploaded via this endpoint do not regard the values specified for image optimization in the route although there could be file rejection if the file uploaded is not an image. The image formats we support at the moment include; .png .jpg .gif .jpeg .svg .webf
async postFile(file: File): Promise<{ filePayload: Object; }> {
const uploadResponse = await axios({
maxContentLength: Infinity, maxBodyLength: Infinity,
headers: {
"Content-Type": "application/json",
'X_API_KEY': process.env.VETACLOUD_PRIVATE_KEY, 'X_ROUTE_NAME': process.env.VETACLOUD_INDEX_ROUTE
},
method: 'POST',
url: 'https://cloud.vetacloud.com/nest/image/50/50/10',
data: { filename: file.originalname, raw: file.buffer }
})
const filePayload = uploadResponse.data.file
return { filePayload }
}
}The first parameter is the height of the image. The second parameter is the length of the image. The third parameter is the quality of the image. To use the default detail of the image's height, length or quality, use 0. If you specify height, you must specify length and vise versa.
Videos that are uploaded via this endpoint do not regard the values specified for video optimization in the route although there could be file rejection if the file uploaded is not a video. The image formats we support at the moment include; .mp4 .mov .wmv .avi .flv .mkv .webm .mpeg-2
async postFile(file: File): Promise<{ filePayload: Object; }> {
const uploadResponse = await axios({
maxContentLength: Infinity, maxBodyLength: Infinity,
headers: {
"Content-Type": "application/json",
'X_API_KEY': process.env.VETACLOUD_PRIVATE_KEY, 'X_ROUTE_NAME': process.env.VETACLOUD_INDEX_ROUTE
},
method: 'POST',
url: 'https://cloud.vetacloud.com/nest/video/50/50/10',
data: { filename: file.originalname, raw: file.buffer }
})
const filePayload = uploadResponse.data.file
return { filePayload }
}
}The first parameter is the height of the video. The second parameter is the length of the video. The third parameter is the quality of the video. To use the default detail of the video's height, length or quality, use 0. If you specify height, you must specify length and vise versa.
To delete a file, the name of the file is required.
async postFile(file: File): Promise<{ filePayload: Object; }> {
const uploadResponse = await axios({
maxContentLength: Infinity, maxBodyLength: Infinity,
headers: {
"Content-Type": "application/json",
'X_API_KEY': process.env.VETACLOUD_PRIVATE_KEY, 'X_ROUTE_NAME': process.env.VETACLOUD_INDEX_ROUTE, 'X_FILE_NAME': "IHNUBDUpl2facbgCu-BSp.png"
},
method: 'delete',
url: 'https://cloud.vetacloud.com/nest/'
})
const filePayload = uploadResponse.data
return { filePayload }
}
}This would fetch all the files you have in a route alongside their details.
async postFile(file: File): Promise<{ filePayload: Object; }> {
const uploadResponse = await axios({
maxContentLength: Infinity, maxBodyLength: Infinity,
headers: {
"Content-Type": "application/json",
'X_API_KEY': process.env.VETACLOUD_PRIVATE_KEY, 'X_ROUTE_NAME': process.env.VETACLOUD_INDEX_ROUTE
},
method: 'GET',
url: 'https://cloud.vetacloud.com/nest/files/'
})
const filePayload = uploadResponse.data
return { filePayload }
}
}The webhook for every upload is in the response's data.
A successful file upload webhook is similar to this. QR Route is generated for all users but the code is generated for only Advanced and Premium users. QR Route is the route of a QR Code which holds the link to the file.
{
status: 201,
success: true
message: 'Successfully Uploaded',
file: {
name: 'QeXhRhba3OVD2ZeLwguUW.jpg',
destination: 'https://cloud.vetacloud.com/uploads/VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d/profile-picture/QeXhRhba3OVD2ZeLwguUW.jpg',
size: 0.068369,
qrroute: 'https://cloud.vetacloud.com/qrCodes/fdd836b12c8ee44d59df6eb42972910b4df628ecf991889994b753c36bfe.png'
}
}The size is in Megabyte. We believe this simplifies accountability for users.
There are so many types of errors that could be returned if a file isnt successfully uploaded but below is an example.
{ status: 400, success: false, message: 'File too large' }Successful file delete
Here is the response y'll get if a file has been successfully deleted
{
status: 204,
success: true
message: 'File successfully deleted'
}When a file is not successfully deleted, the issue is mostly that the delete request has been made before, the file doesn't exist or the file name is wrong.
{
status: 404,
success: false
message: 'File not found. Please check your private key and file name to make sure they are correct'
}{
status: 200,
success: true
message: [
{
name: 'bu6W9WN5FTceSgufxZ7c5.jpg',
upload_key: 'VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d',
route: 'profile-picture',
fileroute: 'https://cloud.vetacloud.com/uploads/VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d/profile-picture/bu6W9WN5FTceSgufxZ7c5.jpg',
date: 'Jul 2022 Thu at 19:4',
size: '68369',
mime_type: 'image/jpeg',
qrroute: 'https://cloud.vetacloud.com/qrCodes/df861cd86a8dcf90931a11405c96da460cfa9832bed107b417c94b170d2d.png'
},
{
name: '7lHz7iyI9Xfz2TArqImlG.jpg',
upload_key: 'VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d',
route: 'profile-picture',
fileroute: 'https://cloud.vetacloud.com/uploads/VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d/profile-picture/7lHz7iyI9Xfz2TArqImlG.jpg',
date: 'Jul 2022 Thu at 19:23',
size: '68369',
mime_type: 'image/jpeg',
qrroute: 'https://cloud.vetacloud.com/qrCodes/932f698d703e5d97ec8a8fcdf0a80990220d54cfd29cd9f69121f219ca87.png'
},
{
name: 'jjdEg3wXAUwe9TbhDGag2.jpg',
upload_key: 'VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d',
route: 'profile-picture',
fileroute: 'https://cloud.vetacloud.com/uploads/VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d/profile-picture/jjdEg3wXAUwe9TbhDGag2.jpg',
date: 'Jul 2022 Thu at 19:30',
size: '68369',
mime_type: 'image/jpeg',
qrroute: 'https://cloud.vetacloud.com/qrCodes/d92deb08d4daad51af5b389192cff952f1c296dadc5659efc29cf53b8731.png'
},
{
name: 'Hr9MezAldZqu8ZTEn5IHS.jpg',
upload_key: 'VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d',
route: 'profile-picture',
fileroute: 'https://cloud.vetacloud.com/uploads/VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d/profile-picture/Hr9MezAldZqu8ZTEn5IHS.jpg',
date: 'Jul 2022 Thu at 19:33',
size: '68369',
mime_type: 'image/jpeg',
qrroute: 'https://cloud.vetacloud.com/qrCodes/50b27205d5fa6a9b13ba2624722e7773828790404e9533e09cef4e9fe944.png'
},
{
name: 'dE0DGao5zJ7M-4qV-Rg_V.jpg',
upload_key: 'VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d',
route: 'profile-picture',
fileroute: 'https://cloud.vetacloud.com/uploads/VTCD_PUBLIC_f2b95f3a6138e01f51de562ff10a9d/profile-picture/dE0DGao5zJ7M-4qV-Rg_V.jpg',
date: 'Jul 2022 Thu at 19:38',
size: '68369',
mime_type: 'image/jpeg',
qrroute: 'https://cloud.vetacloud.com/qrCodes/07b0c89456563eea555daa3d5572ab5c3b3a4bc490c6064c08708ba10def.png'
}
]
}The maximum file size we allow is 300 MB. This would increase in our future updates. Okay, byeee!