Use the /sapi/awsupload endpoint to register upload sessions and associate direct file uploads with mediaclip objects in the Blue Billywig Online Video Platform (OVP).
The OVP uses AWS S3 for file storage. Each OVP account has a dedicated AWS S3 bucket. To create a new mediaclip, the following steps are required:
- Register an upload session (this endpoint).
- Register a mediaclip (see /sapi/mediaclip).
- Upload the file to the AWS S3 bucket using the uploadIdentifier received in step one. Read more about how to generate your AWS S3 credentials.
Alternatively, read more about uploading directly to S3.
1.0 | AWS Upload Session Object
1.1 | Example AWS Upload Session Object
{
"accessKey": "AKIAABCDEFGHIJKLMNO",
"acl": "public-read-write",
"currentDate": "Thu, 21 Sep 2023 12:29:25 +0200",
"uploadIdentifier": "e6ad9ab8bbc8dd10ee3d4465c09ad701",
"endpoint": "s3.eu-west-1.amazonaws.com/mm.yourcompanyname.bbvms.com",
"region": "eu-west-1",
"path": "upload/yourcompanyname/2023/09/21/e6ad9ab8bbc8dd10ee3d4465c09ad701"
}1.2 | Attributes
| Parameter | Description |
|---|---|
| accessKey | (string) AWS access key ID. Read-only. |
| acl | (string) Access control list. Read-only. |
| currentDate | (string) RFC 822 date/time the upload session was registered. Read-only. |
| uploadIdentifier | (string) Unique hash identifying the upload session. Use this value as a reference when associating the uploaded file with a mediaclip. Read-only. |
| endpoint | (string) Canonical AWS S3 endpoint URL. Read-only. |
| region | (string) AWS S3 region. Read-only. |
| path | (string) Upload directory path on the S3 bucket. Read-only. |
2.0 | Retrieve
GET /sapi/awsupload
Registers and retrieves the credentials for a new upload session to Amazon S3.