Generate an Upload URL

POST

https://api.zid.sa/v1/products/{{product-id}}/downloadables/generate-s3-presigned-url/

The "Generate an Upload URL" endpoint allows users to generate a pre-signed URL for uploading a digital file directly to cloud storage. This URL enables secure, temporary access for uploading files associated with a digital product.

🔑Scopes

products.read_write - Products Read & Write

Request

Header Params

Store-Id

integer

optional

Unique identifier of the store.

Example:

Accept-Language

string

optional

Preferred language for the response. Defaults to en if not specified.

Example:

X-manager-Token

string

optional

This token is used to authenticate and access information related to the store. It is obtained through an OAuth mechanism and is required to perform operations on the store's data. The X-Manager-Token should be included in the header of API requests that require store-related information.

Example:

eyJpdiI6ImNSZ0NKWXlMZ3hEcDZudU1wS3R1dVE9PSIsInZhbHVlIjoiZnRqdGRVUE1IdU9PaytvSk1pbGV5Zk5YUk9pRG9ONWVwa1NaTUIvN0JkYzgwNlFUV3h6ZCs5S2VkRDVaSy9GbWRDQm9adlR4SEFHMStpUDNuM1V1dG9PUENCZ0R6eHJYeEZHLzhzMFlWb25NMHI3TE1NZDIzbnNEQlI3ekNycE5RVHVBczQ2L1FKSjF1UTI3Q0xzaXNtcmM1Mi9LUHc3aDEvV0J6R2ZyUkJCT0lrbXg3c0NiN0JEL1RvWFlSSWZ4M1J2MVhiRWZZcUdXMGI3NVJlMXA0aFNlcE02Z1RPak43Ump6Z1BQdEpnMD0iLCJtYWMiOiIxZmU2YzlmYWE1NTE0OTQwNDFmMTkxYzdhNGM0Zjk2NDgyYjI4ZWM2NjlkODU3NTI4NzM1NTY0YmVkZjMxNzc5IiwidGFnIjoiIn0=:

Currency

string

optional

The currency in which the data should be returned. This should be provided as an ISO 4217 currency code. For example, SAR for Saudi Riyal, USD for United States Dollar, KWD for Kuwaiti Dinar, etc.

Example:

SAR

Role

string

optional

Role of the user.

Example:

Manager

Authorization

string

optional

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

eyJ8eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzIiwianRpIjoiMTQyZjEyYTVlY2JhNzIyZTZlMjkwZjVlZDRhNmEwZDk1N2M4MGM3ZTVhODE4MjMyMjhjMzk0YjkyMGFkMmQ2ZDFkODI2YTYxOTI3MTEwMzUiLCJpYXQiOjE3MTA5NzY3MDYuNzUwOTI0LCJuYmYiOjE3MTA5NzY3MDYuNzUwOTI3LCJleHAiOjE3NDI1MTI3MDYuNzA2OTc5LCJzdWIiOiIzIiwic2NvcGVzIjpbIioiXX0.k2xkXywMs4eFArabnVFPH2CfBdMT1M-x0i6xGxM_OfUqKpFRxlTxj7tapbuSKDa2e-lyVr9AZwuCidj-5v1WQjYgj_bYRE-bi4CvGgY9reSVRy5l5a7i19nXNWyDfYHc_20CgMwrAUVlJoZLUkrQ3O6dAdjo83aoyktTKKfI7Q3-iWdFPAEzby_1pU5T883whYEWwfXWGzICwDQzulQzLm7dSAOy2xUNdB2CHn0tHCNHeaY8Mx11MBABAw_RVPZddR7kDOf5jc1g6fJ9YYGeru1ptZPwK2vHlRLnVJdbN5f4byE77LEVyb3daWuv3sYeIdEV3eV9WLmeGt0FlOjxpTHpEqBN4t1np6vV5nZyoluP9SuDXt5wKI7o3uPhat8vZ4B8pc-35484Y5_RxHyP2fxgQStqLFvMypJGoLMh2zg39sUP3oI35R1bIadKt49MM2c-RjP-16ngbK6np104hdFYojelf9EFRN9tY-yIUEyg5fWLw6mIBOxDFcqjZRUc-3P5VPgdeacp0-oU968YB1gP3155Dsu8DVxDr-iuQ5deusTpYnFlqokJ26VknHRJSMxlVBWptljv9EHNFw6a5gvcj8xht5ldm4b9RqisxUC0OlwJtK_pmhp-srp6biaj54u9zIvjKd-seJNumF1VM2nfJk63TnfPZbG9SLyPjuU

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api.zid.sa/v1/products/{{product-id}}/downloadables/generate-s3-presigned-url/' \
--header 'Store-Id: 3' \
--header 'Accept-Language: ar' \
--header 'X-manager-Token: eyJpdiI6ImNSZ0NKWXlMZ3hEcDZudU1wS3R1dVE9PSIsInZhbHVlIjoiZnRqdGRVUE1IdU9PaytvSk1pbGV5Zk5YUk9pRG9ONWVwa1NaTUIvN0JkYzgwNlFUV3h6ZCs5S2VkRDVaSy9GbWRDQm9adlR4SEFHMStpUDNuM1V1dG9PUENCZ0R6eHJYeEZHLzhzMFlWb25NMHI3TE1NZDIzbnNEQlI3ekNycE5RVHVBczQ2L1FKSjF1UTI3Q0xzaXNtcmM1Mi9LUHc3aDEvV0J6R2ZyUkJCT0lrbXg3c0NiN0JEL1RvWFlSSWZ4M1J2MVhiRWZZcUdXMGI3NVJlMXA0aFNlcE02Z1RPak43Ump6Z1BQdEpnMD0iLCJtYWMiOiIxZmU2YzlmYWE1NTE0OTQwNDFmMTkxYzdhNGM0Zjk2NDgyYjI4ZWM2NjlkODU3NTI4NzM1NTY0YmVkZjMxNzc5IiwidGFnIjoiIn0=:' \
--header 'Currency: SAR' \
--header 'Role: Manager' \
--header 'Authorization: eyJ8eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzIiwianRpIjoiMTQyZjEyYTVlY2JhNzIyZTZlMjkwZjVlZDRhNmEwZDk1N2M4MGM3ZTVhODE4MjMyMjhjMzk0YjkyMGFkMmQ2ZDFkODI2YTYxOTI3MTEwMzUiLCJpYXQiOjE3MTA5NzY3MDYuNzUwOTI0LCJuYmYiOjE3MTA5NzY3MDYuNzUwOTI3LCJleHAiOjE3NDI1MTI3MDYuNzA2OTc5LCJzdWIiOiIzIiwic2NvcGVzIjpbIioiXX0.k2xkXywMs4eFArabnVFPH2CfBdMT1M-x0i6xGxM_OfUqKpFRxlTxj7tapbuSKDa2e-lyVr9AZwuCidj-5v1WQjYgj_bYRE-bi4CvGgY9reSVRy5l5a7i19nXNWyDfYHc_20CgMwrAUVlJoZLUkrQ3O6dAdjo83aoyktTKKfI7Q3-iWdFPAEzby_1pU5T883whYEWwfXWGzICwDQzulQzLm7dSAOy2xUNdB2CHn0tHCNHeaY8Mx11MBABAw_RVPZddR7kDOf5jc1g6fJ9YYGeru1ptZPwK2vHlRLnVJdbN5f4byE77LEVyb3daWuv3sYeIdEV3eV9WLmeGt0FlOjxpTHpEqBN4t1np6vV5nZyoluP9SuDXt5wKI7o3uPhat8vZ4B8pc-35484Y5_RxHyP2fxgQStqLFvMypJGoLMh2zg39sUP3oI35R1bIadKt49MM2c-RjP-16ngbK6np104hdFYojelf9EFRN9tY-yIUEyg5fWLw6mIBOxDFcqjZRUc-3P5VPgdeacp0-oU968YB1gP3155Dsu8DVxDr-iuQ5deusTpYnFlqokJ26VknHRJSMxlVBWptljv9EHNFw6a5gvcj8xht5ldm4b9RqisxUC0OlwJtK_pmhp-srp6biaj54u9zIvjKd-seJNumF1VM2nfJk63TnfPZbG9SLyPjuU'

Responses

🟢200Success

application/json

Body

response

object

required

url

string

required

The pre-signed URL for direct file upload to the specified cloud storage location, which is active for a limited time.

Example:

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

fields

object

required

An object containing fields required for uploading the file.

size_limit

integer

required

Maximum allowed file size (in bytes) for the upload.

Example:

1073741824

Example

{
    "response": {
        "url": "https://s3.eu-west-1.amazonaws.com/private.zid.store",
        "fields": {
            "key": "9fc92996-ffbe-4bca-9b8e-6682137fe7b6/product-downloadables/8244389b-8fe3-47dc-85ae-2f8e9e95f899",
            "AWSAccessKeyId": "AKIAXOL3MW23VCA3WLDK",
            "policy": "eyJleHBpcmF0aW9uIjogIjIwMjQtMTEtMDNUMDU6NTU6MTZaIiwgImNvbmRpdGlvbnMiOiBbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsIDAsIDEwNzM3NDE4MjRdLCB7ImJ1Y2tldCI6ICJwcml2YXRlLnppZC5zdG9yZSJ9LCB7ImtleSI6ICI5ZmM5Mjk5Ni1mZmJlLTRiY2EtOWI4ZS02NjgyMTM3ZmU3YjYvcHJvZHVjdC1kb3dubG9hZGFibGVzLzgyNDQzODliLThmZTMtNDdkYy04NWFlLTJmOGU5ZTk1Zjg5OSJ9XX0=",
            "signature": "R5oESN7BQbUFL52iG64WSTaCAbw="
        }
    },
    "size_limit": 1073741824
}

Modified at 2025-01-28 06:02:48

Create Downloadable Product

Upload File to S3