Isuru Bimsara
61 lines
1.8 KiB
Markdown
61 lines
1.8 KiB
Markdown
# Upload API
|
|
|
|
#### Upload A File
|
|
|
|
**Endpoint**
|
|
|
|
```
|
|
POST: http://localhost:3070/api/upload
|
|
```
|
|
|
|
**Request Body**
|
|
|
|
```
|
|
Key: file
|
|
Value: uploadfile.pdf / avatar.png
|
|
```
|
|
|
|
|
|
**Respond**
|
|
|
|
```json
|
|
{
|
|
"success": true,
|
|
"message": "File uploaded successfully",
|
|
"data": {
|
|
"id": 4,
|
|
"file_path": "uploads/1f642d1d-dc79-423f-aad0-36df9938c1ff.pdf",
|
|
"file_type": "application/pdf",
|
|
"file_size": 15640,
|
|
"original_name": "SamplePDF.pdf",
|
|
"use_for": "vendor_documents",
|
|
"uploaded_by": "usr_5ff8afec-5ddc-47d9-a63f-b43df0d8c3b4",
|
|
"updatedAt": "2026-04-04T19:44:03.252Z",
|
|
"createdAt": "2026-04-04T19:44:03.252Z",
|
|
"file_url": "https://oceanic-bucket.s3.ap-southeast-1.amazonaws.com/uploads/1f642d1d-dc79-423f-aad0-36df9938c1ff.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIASP2AP6EU76EJ63PD%2F20260404%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260404T194403Z&X-Amz-Expires=3600&X-Amz-Signature=f9ecb283dfe206e87fa9bbd9f59194dfca4cdb11d8bb02f0ae5abd89db7ddc04&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject"
|
|
}
|
|
}
|
|
```
|
|
|
|
#### Get Uploaded File
|
|
|
|
**Endpoint**
|
|
|
|
```
|
|
POST: http://localhost:3070/api/upload/signed-url/:id
|
|
```
|
|
|
|
Example: http://localhost:3070/api/upload/signed-url/3
|
|
|
|
**Respond**
|
|
|
|
```json
|
|
{
|
|
"success": true,
|
|
"message": "File URL retrieved successfully",
|
|
"data": {
|
|
"id": 3,
|
|
"file_url": "https://oceanic-bucket.s3.ap-southeast-1.amazonaws.com/uploads/9c441266-c1ee-4813-9b81-cf13276535c9.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIASP2AP6EU76EJ63PD%2F20260404%2Fap-southeast-1%2Fs3%2Faws4_request&X-Amz-Date=20260404T195205Z&X-Amz-Expires=3600&X-Amz-Signature=de8f9a4658b2802af4230f0ebba25511fb57e75cce4be75aa2e34d40a771bffb&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject"
|
|
}
|
|
}
|
|
``` |