Upload File to S3

GET

https://api.zid.sa/https://s3.eu-west-1.amazonaws.com/private.zid.store

The "Upload File to S3" endpoint provides a pre-signed URL for secure, temporary access to upload files directly to Amazon S3 storage. This enables clients to upload files without needing direct S3 credentials, ensuring secure and efficient file handling for digital assets.

🔑Scopes

products.read - Products Read

Request

Body Params multipart/form-data

key

string

optional

The path within S3 where the uploaded file will be stored. It includes a unique identifier to prevent overwriting, typically organized by product type and ID.

Example:

9fc92096-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899:

AWSAccessKeyId

string

optional

The AWS access key ID needed for authenticated access to the S3 bucket, providing permission to upload the file.

Example:

AKIAXOL9MW23VCA3WLDK:

policy

string

optional

A Base64-encoded policy document that outlines the conditions and permissions for the upload request, including expiration time and allowed content length.

Example:

eyJleHBgcmF0aW9uIjogIjIwMjQtMTEtMDNUMDU6NTU6MTZaIiwgImNvbmRpdGlvbnMiOiBbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsIDAsIDEwNzM3NDE4MjRdLCB7ImJ1Y2tldCI6ICJwcml2YXRlLnppZC5zdG9yZSJ9LCB7ImtleSI6ICI5ZmM5Mjk5Ni1mZmJlLTRiY2EtOWI4ZS02NjgyMTM3ZmU3YjYvcHJvZHVjdC1kb3dubG9hZGFibGVzLzgyNDQzODliLThmZTMtNDdkYy04NWFlLTJmOGU5ZTk1Zjg5OSJ9XX0=:

signature

string

optional

An encrypted signature generated from the policy to verify that the upload request complies with the specified conditions.

Example:

R5oESN99BQbUFL52iG64WSTaCAbw=:

file

string

optional

The file to be uploaded to S3. It is sent as binary data in the request body, enabling direct transfer to the specified storage location.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://s3.eu-west-1.amazonaws.com/private.zid.store' \
--form 'key="9fc92096-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899:"' \
--form 'AWSAccessKeyId="AKIAXOL9MW23VCA3WLDK:"' \
--form 'policy="eyJleHBgcmF0aW9uIjogIjIwMjQtMTEtMDNUMDU6NTU6MTZaIiwgImNvbmRpdGlvbnMiOiBbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsIDAsIDEwNzM3NDE4MjRdLCB7ImJ1Y2tldCI6ICJwcml2YXRlLnppZC5zdG9yZSJ9LCB7ImtleSI6ICI5ZmM5Mjk5Ni1mZmJlLTRiY2EtOWI4ZS02NjgyMTM3ZmU3YjYvcHJvZHVjdC1kb3dubG9hZGFibGVzLzgyNDQzODliLThmZTMtNDdkYy04NWFlLTJmOGU5ZTk1Zjg5OSJ9XX0=:"' \
--form 'signature="R5oESN99BQbUFL52iG64WSTaCAbw=:"' \
--form 'file=""'

Responses

🟢200OK

application/json

Body

object {0}

Example

{}

Modified at 2025-01-28 06:03:29

Generate an Upload URL

Create Product Downloadables