FileStorage

This service provides functionality to manage assets and generate pdf. You can upload the assets, get the cdn link for the assets, proxy the assets and many more things.

File Browse

Browse files by fetching all files in a directory based on the provided namespace, query, and request body parameters. It determines the directory path, retrieves paginated files accordingly, and serializes the response for further processing. This method optimizes directory browsing functionality within the system.

Operations
GET
/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/browse
# Application browse files.
GET

Application browse files.

Browse files within an application.
Requires application/assets/read access scope.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page
integer
page no
limit
integer
Limit
search
string
Search
Response
200
400
Success
Properties
items
array of object
Array of Properties
_id
string
file_name
string
file_path
string
success
boolean
namespace
string
content_type
string
size
number
operation
string
tags
array of string
cdn
object
Properties
url
string
upload
object
Properties
url
string
expiry
number
created_by
object
Properties
username
string
company_id
number
bucket_key
string
created_at
string
updated_at
string
__v
number
page
object
Properties
item_total
integer
| int32
next_id
string
has_previous
boolean
has_next
boolean
current
integer
| int32
type
string
size
integer
| int32
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
page:
1
limit:
1
search:
"test"
GET
/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/browse
Loading...
Response
Loading...

File Transfer Suite

Enable seamless file management within application and across external sources. It copy files, ensuring data replication and backup for various purposes. Additionally, browse, navigate, and utilize proxy functionality for interacting with files and performing operations on them within the platform

Operations
POST
/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/browse
# Browse Files
POST

Browse Files

Browse Files
Requires application/assets/write access scope.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
page
integer
page no
limit
integer
Limit
search
string
Search
Request body
extension_slug
string
Response
200
400
Success
Properties
items
array of object
Array of Properties
_id
string
file_name
string
file_path
string
success
boolean
namespace
string
content_type
string
size
number
operation
string
tags
array of string
cdn
object
Properties
url
string
upload
object
Properties
url
string
expiry
number
created_by
object
Properties
username
string
company_id
number
bucket_key
string
created_at
string
updated_at
string
__v
number
page
object
Properties
item_total
integer
| int32
next_id
string
has_previous
boolean
has_next
boolean
current
integer
| int32
type
string
size
integer
| int32
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
page:
1
limit:
1
search:
"test"
body:
body
POST
/service/platform/assets/v1.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/browse
Loading...
Response
Loading...

File Upload and Management

File upload is a feature that enables users to upload files from their device to a designated storage location in the system. The process of uploading begins by validating user parameters and organizing files into different groups based on their type using something called a "namespace". This helps in storing the files into Public and Private buckets Private - The files stored in private bucket is accessible via getSignedUrl method for a temporary duration. Public - The files stored in public bucket is accessible via cdn url Seller initiate the upload process by selecting files through drag-and-drop, pre-existing images, choosing from your device, uploading via URL, or entering an image URL. 1. Start Upload - Once seller calls start upload will receive a signed URL to initiate the upload process. 2. Utilize a Google Cloud Platform (GCP) method to upload the file through the obtained signed URL. 3. Complete File upload - Important file details such as name, size, content type, and namespace are collected and linked to maintain data integrity within the system's database. Once you upload a file, you receive a message with all the details about where your file is stored, including a secure URL for uploading files to the designated storage and a CDN (Content Delivery Network) URL for future accessibility. Furthermore, the system sets an expiration time for access links(signed Url) enhancing security measures.

Operations
POST
/service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/start
# Application start upload.
POST
/service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/complete
# Application complete upload.
POST

Application start upload.

Start uploading a file from an application and returns a storage link in response.
Requires application/assets/write access scope.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
file_name
string
Required
content_type
string
Required
size
integer
Required
tags
array of string
params
object
Response
200
400
Success. Returns a response containing relaving and absolute_url of storage service
FileUpload
file_name
string
file_path
string
content_type
string
method
string
namespace
string
operation
string
size
integer
upload
object (Upload)
Upload
expiry
integer
url
string
tags
array of string
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
POST
/service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/start
Loading...
Response
Loading...
POST

Application complete upload.

Finish uploading a file from an application.
Requires application/assets/write access scope.
Parameters
namespace
string
Required
Segregation of different types of files(products, orders, logistics etc), Required for validating the data of the file being uploaded, decides where exactly the file will be stored inside the storage bucket.
company_id
integer
Required
This is company id
application_id
string
Required
This is application id
Request body
file_name
string
Required
file_path
string
Required
content_type
string
Required
method
string
namespace
string
Required
operation
string
Required
size
integer
Required
upload
object (Upload)
Required
Upload
expiry
integer
Required
url
string
Required
tags
array of string
Response
200
400
Success
FileUploadComplete
_id
string
file_name
string
file_path
string
content_type
string
namespace
string
operation
string
company_id
number
size
integer
upload
object (Upload)
Upload
expiry
integer
url
string
cdn
object (CDN)
CDN
url
string
absolute_url
string
relative_url
string
success
boolean
tags
array of string
created_on
string
| date-time
modified_on
string
| date-time
created_by
object (CreatedBy)
CreatedBy
username
string
Examples
Parameters
namespace:
"test"
company_id:
2
application_id:
"5eda528b97457fe43a733ace"
body:
body
POST
/service/platform/assets/v2.0/company/{company_id}/application/{application_id}/namespaces/{namespace}/upload/complete
Loading...
Response
Loading...